Merge pull request #2 from AbleTech/block_syntax

new block syntax functionality

Author: nigelramsay

.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - jruby-19mode # JRuby in 1.9 mode

CHANGELOG.md

@@ -0,0 +1,13 @@
+# EasyAPI 0.2.0 (July 28, 2014) #
+
+* Add support for new block-style syntax
+* Add support for JRuby
+
+# ActiveAttr 0.1.3 (April 16, 2014) #
+
+* Return correct content_type for jsonp requests
+
+# ActiveAttr 0.1.2 (March 11, 2013) #
+
+* Genericize error messages
+* Add support for Ruby 1.8.7

README.md

@@ -1,5 +1,7 @@
 # Easy::Api
 
+[<img src="https://travis-ci.org/AbleTech/easy-api.png" />](https://travis-ci.org/AbleTech/easy-api)
+
 A repository of common, reusable API code. Its purpose is to make all of Abletech's APIs respond in a consistent manner.
 
 ## Installation
@@ -31,16 +33,59 @@ To initialise an error, pass in the type you want, e.g.
 If you want to override the default error message, pass in a custom message, e.g.
 
     Easy::Api::Error.new(:invalid, @user.errors.full_messages.join(', '))
- 
+
 Easy::Api::Error objects have a code (e.g. 404) and a message (e.g. 'Resource not found')
 
+### Using Easy::Api
+
+Add the following line to all Api Controllers:
+
+    include Easy::Api
+
+Then in your Api actions, do your logic inside a block:
+
+     easy_api do |api|
+        api.parcel = Parcel.first
+        api.status_code = 200
+        api.success = true
+        api.render_result(format: params[:format])
+     end
+
+If the request is a success, you must set
+
+     api.status_code = 200
+     api.success = true
+
+and you can also set any other values you want to send back, e.g.
+
+    api.parcel = Parcel.first
+
+If the request is unsuccessful, you must set the status_code, e.g.
+
+    api.status_code = 401
+
+and you also need to set error to be an instance of Easy::Api::Error, e.g.
+
+    api.error = Easy::Api::Error.new(:unauthorized)
+
+Then render the result
+
+     api.render_result(format: params[:format])
+
+If your API supports callbacks these can also be passed
+
+     api.render_result(format: params[:format], callback: params[:callback])
+
 ### Using Easy::Api::ControllerMethods
+
+**Depricated**
+
 Add the following line to all Api Controllers:
-  
+
     include Easy::Api::ControllerMethods
 
-then in your Api actions, add values to the @result (Easy::Api::Result) object. 
-If the request is a success, you must set 
+then in your Api actions, add values to the @result (Easy::Api::Result) object.
+If the request is a success, you must set
 
      @result.status_code = 200
      @result.success = true
@@ -57,6 +102,10 @@ and you also need to set error to be an instance of Easy::Api::Error, e.g.
 
     @result.error = Easy::Api::Error.new(:unauthorized)
 
+Then render the result
+
+    render_format
+
 ## Contributing
 
 1. Fork it

easy-api.gemspec

@@ -1,25 +1,25 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'easy/api/version'
+require File.expand_path('../lib/easy/api/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "easy-api"
   gem.version       = Easy::Api::VERSION
-  gem.authors       = ["Shevaun Coker"]
-  gem.email         = ["shevaun.coker@abletech.co.nz"]
-  gem.description   = %q{A repository of common, reusable API code}
-  gem.summary       = %q{Provides consistent responses for Abletech APIs}
-  gem.homepage      = ""
+  gem.authors       = ["Shevaun Coker", "Joseph Leniston", "Nigel Ramsay"]
+  gem.email         = ["shevaun.coker@abletech.co.nz", "joseph.leniston@abletech.co.nz", "nigel.ramsay@abletech.co.nz"]
+  gem.description   = %q{Enables consistent responses for API calls}
+  gem.homepage      = "https://github.com/AbleTech/easy-api"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'rails', '>= 3.0.0'
-
+  gem.add_development_dependency 'activemodel', '>= 3.0.0'
+  gem.add_development_dependency 'actionpack', '>= 3.0.0'
+  gem.add_development_dependency 'activesupport', '>= 3.0.0'
+  gem.add_development_dependency 'multi_json', '~> 1.0'
   gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rspec', '~> 2.0'
+  gem.add_development_dependency 'rspec', '>= 2.14'
+  gem.add_development_dependency 'rspec-rails'
 end

lib/easy-api.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/easy/api/version'
+require File.dirname(__FILE__) + '/easy/api/controller_methods'
+require File.dirname(__FILE__) + '/easy/api/block_wrapper'
+require File.dirname(__FILE__) + '/easy/api/result'
+require File.dirname(__FILE__) + '/easy/api/error'

lib/easy/api.rb

@@ -1,4 +1,11 @@
 require 'easy/api/version'
 require 'easy/api/controller_methods'
+require 'easy/api/block_wrapper'
 require 'easy/api/result'
 require 'easy/api/error'
+
+module Easy::Api
+  def self.included(base)
+    base.send :include, Easy::Api::BlockWrapper
+  end
+end

lib/easy/api/block_wrapper.rb

@@ -0,0 +1,42 @@
+# Include this module in all API controllers to get consistent responses
+module Easy::Api::BlockWrapper
+  module InstanceMethods
+
+    # Initialises a new Easy::Api::Wrapper object takes a block of code to be rendered using the formatter
+    def easy_api &block
+      wrapper ||= Wrapper.new(self)
+      yield(wrapper)
+    end
+
+  end
+
+  def self.included(base)
+    base.send :include, InstanceMethods
+  end
+
+  # A class to encapulate the API code so it can be called from the block.
+  class Wrapper
+
+    def initialize(controller)
+      @controller = controller
+      @result ||= Easy::Api::Result.new
+    end
+
+    # use the controller to render the response
+    def render_result(render_params)
+      format = (render_params[:format] || 'json').try(:to_sym)
+      if render_params[:callback].blank?
+        @controller.render(format => @result, :status => @result.status_code)
+      else
+        @controller.render(format => @result, :status => @result.status_code, :callback => render_params[:callback], :content_type => 'application/javascript')
+      end
+    end
+
+    # Delegate other method calls to the result object
+    def method_missing(name, *args, &block)
+      @result.send(name, *args, &block)
+    end
+
+  end
+
+end

lib/easy/api/version.rb

@@ -1,5 +1,5 @@
 module Easy
   module Api
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

spec/fixtures/application.rb

@@ -0,0 +1,22 @@
+require 'active_support/all'
+require 'action_controller'
+require 'action_dispatch'
+
+module Rails
+  class App
+    def env_config; {} end
+    def routes
+      return @routes if defined?(@routes)
+      @routes = ActionDispatch::Routing::RouteSet.new
+      @routes.draw do
+        resources :customers
+        resources :users
+      end
+      @routes
+    end
+  end
+
+  def self.application
+    @app ||= App.new
+  end
+end

spec/fixtures/controllers.rb

@@ -0,0 +1,43 @@
+class TestController < ActionController::Base
+  include Rails.application.routes.url_helpers
+end
+
+class UsersController < TestController
+  include Easy::Api::ControllerMethods
+
+  def index
+    @result.users = [User.new("bob", 25), User.new('sally',40)]
+    @result.success = true
+    @result.status_code = 200
+    render_format
+  end
+
+  def show
+    @result.user = User.new("bob", 25)
+    @result.success = true
+    @result.status_code = 200
+    render_format
+  end
+end
+
+class CustomersController < TestController
+  include Easy::Api
+
+  def index
+    easy_api do |api|
+      api.customers = [Customer.new("fred", 19), Customer.new('jackie',21)]
+      api.success = true
+      api.status_code = 200
+      api.render_result(format: params[:format], callback: params[:callback])
+    end
+  end
+
+  def show
+    easy_api do |api|
+      api.customer = Customer.new("fred", 21)
+      api.success = true
+      api.status_code = 200
+      api.render_result(format: params[:format], callback: params[:callback])
+    end
+  end
+end