easy-api 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7a7b501b68e2d27078a346db4d2e9ccd369c227
-  data.tar.gz: 4c9343aac20833e366a9e62d213457f9c1e76e47
+  metadata.gz: 94b5b22c8b02c19de08ca14585473511abbf81d4
+  data.tar.gz: 73a7eaadbdc4601a5fbf1b92275aef5103765fa1
 SHA512:
-  metadata.gz: 24a3a204a78387f1571f66f832c4b343b5c1b5786b3fac965449b514da09bab49ae71a9bb0d35e1c7cf56e9ebb12d2663be60545501e34bcc0a95d983a7a2f85
-  data.tar.gz: e98d3bc861219153d22ef088100079c1346e75dd7273b14ba2a5a12a9abf6de6bdb5e6971d4f53df7a1a9673e8f3d10431ec3fbdb8891799ee72ecfdc7e85842
+  metadata.gz: 5fab722ebc87aca767b53bab435d31d968bf9c3f43666052e962df18a1ea78c89ff7766c86d45acfa0eb25f1c559e10b2de272d9cf5bd0fa53765cb46241f6a2
+  data.tar.gz: 78242156bbe9579e5553e1fdba48fc4383b36f9e979ac766409e49221532a083cc6dd2464ece1ba2ea95cc400985306a0c51fb8de5242b93accdf839d44fa2a4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# EasyAPI 0.3.0 (December 18, 2015) #
+
+* Add support for externally generated JSON and XML
+
 # EasyAPI 0.2.3 (August 28, 2015) #
 
 * Allow Easy::Api:Error.codes and Easy::Api:Error.messages to be added to

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec', all_after_pass: true, all_on_start: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -83,9 +83,40 @@ If your API supports callbacks (JSONP) these can also be passed. The returned co
 
      api.render_result(format: params[:format], callback: params[:callback])
 
+## Support for externally generated JSON and XML
+
+Sometimes it makes sense to use your database to generate the raw JSON or XML. If
+you need to do this, you can use the raw method as shown below.
+
+    easy_api do |api|
+       api.status_code = 200
+       api.success = true
+       api.year = 2015
+       api.raw.animals = '[{"name" => "Charles Bird"}, {"name" => "Silver"}, {"name" => "Lassie"}]'
+
+       api.render_result(format: params[:format])
+    end
+
+or support both JSON and XML:
+
+    easy_api do |api|
+       api.status_code = 200
+       api.success = true
+       api.enterprise = 'safe'
+
+       if params[:format] == 'xml'
+         api.raw.categories = '<category>Large</category><category>Medium</category><category>Small</category>'
+       else
+         api.raw.categories = '["Large", "Medium", "Small"]'
+       end
+
+       api.render_result(format: params[:format])
+    end
+
+
 ### Using Easy::Api::ControllerMethods
 
-**Depricated**
+**Deprecated**
 
 Add the following line to all Api Controllers:
 

data/easy-api.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rspec', '>= 2.14'
   gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'guard-rspec', '~> 4.6'
 end

data/lib/easy/api/controller_methods.rb

@@ -21,7 +21,7 @@ module Easy::Api::ControllerMethods
             content_type = 'application/json'
           end
 
-          render :json => @result, :status => status, :callback => params[:callback], :content_type => content_type
+          render :json => @result.to_json, :status => status, :callback => params[:callback], :content_type => content_type
         end
       end
     end

data/lib/easy/api/result.rb

@@ -8,9 +8,14 @@ module Easy::Api
   # #status_code
   # success
   # error (see Easy::Api::Error#new)
-  class Result < OpenStruct
+  class Result
+
     attr_writer :success, :status_code, :error
 
+    def initialize
+      @native_attributes = {}
+    end
+
     # An instance of Easy::Api::Error or nil if there is no error
     # @return [Easy::Api::Error, nil]
     def error
@@ -30,12 +35,26 @@ module Easy::Api
       @status_code || raise("Easy::Api::Result needs a status_code!")
     end
 
-    # Used by Rails to render the result as json
-    #
-    # Will always contain 'success', the error if there is one, and any dynamic attributes.
-    # @return [Hash]
-    def as_json(options={})
-      convert_to_hash
+    def raw
+      @raw ||= RawAttributesResult.new
+    end
+
+    def to_json(options={})
+      json = non_raw_attributes.to_json
+
+      if raw.attributes.any?
+        json = json.chop # remove the closing '}'
+
+        raw.attributes.each_with_index do |(attr_name, raw_value), index|
+          json << ','
+
+          json << '"' << attr_name << '":' << raw_value
+        end
+
+        json << '}'
+      end
+
+      json
     end
 
     # Used by Rails to parse the result as xml
@@ -46,15 +65,58 @@ module Easy::Api
       options = options.dup
       options[:root]        ||= 'response'
       options[:skip_types]  ||= true
-      convert_to_hash.to_xml(options)
+
+      xml = non_raw_attributes.to_xml(options)
+
+      if raw.attributes.any?
+        xml.gsub!(/<\/#{options[:root]}>[\s\n]*\z/, '') # remove the closing </response>
+
+        raw.attributes.each_with_index do |(attr_name, raw_value), index|
+          xml << '<' << attr_name << '>' << raw_value << '</' << attr_name << '>'
+        end
+
+        xml << "</#{options[:root]}>"
+      end
+
+      xml
+    end
+
+    def method_missing(symbol, *args)
+      if symbol =~ /.+=/
+        attr_name = symbol.to_s[0..-2]
+        @native_attributes[attr_name] = args.first
+      else
+        super
+      end
     end
 
     private
 
-    def convert_to_hash
-      hash = marshal_dump.merge(:success => success)
-      hash[:error] = error unless error.nil?
+    def non_raw_attributes
+      hash = @native_attributes.merge('success' => success)
+
+      if error
+        hash['error'] = error.as_json
+      end
+
       hash
     end
   end
+
+  class RawAttributesResult
+    def initialize
+      @attributes = {}
+    end
+
+    attr_reader :attributes
+
+    def method_missing(symbol, *args)
+      if symbol =~ /.+=/
+        attr_name = symbol.to_s[0..-2]
+        @attributes[attr_name] = args.first
+      else
+        super
+      end
+    end
+  end
 end

data/lib/easy/api/version.rb

@@ -1,5 +1,5 @@
 module Easy
   module Api
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/spec/lib/easy/api/result_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
+require 'json'
 
 describe Easy::Api::Result do
-  describe "#as_json" do
+  describe "#to_json" do
     let(:result) { Easy::Api::Result.new }
-    subject { result.as_json }
+    subject(:parsed_json) { JSON.parse(result.to_json) }
 
     context "when result is unsuccessful" do
       let(:api_error) { Easy::Api::Error.new(:unauthorized) }
@@ -12,65 +13,110 @@ describe Easy::Api::Result do
         result.error = api_error
       end
 
+      it "contain the expected values" do
+        expect(parsed_json).to eq({'success' => false, 'error' => {'code' => 401, 'message' => 'Unauthorized request'}})
+      end
+    end
+
+    context "when result is successful" do
+
+      before do
+        result.success = true
+        result.customer =  "Bob Loblaw"
+      end
+
       it "has a success key" do
-       expect(subject).to have_key(:success)
+       expect(subject).to have_key('success')
+      end
+
+      it "is successful" do
+        expect(subject['success']).to be(true)
+      end
+
+      it "has a customer key" do
+       expect(subject).to have_key('customer')
       end
 
-      it "is not successful" do
-        expect(subject[:success]).to be(false)
+      it "has a customer name" do
+       expect(subject['customer']).to eql "Bob Loblaw"
       end
 
       it "has no status code" do
-        expect(subject).to_not have_key(:status_code)
+        expect(subject).to_not have_key('status_code')
       end
+    end
+  end
 
-      it "has an error" do
-       expect(subject).to have_key(:error)
+  describe '#to_json' do
+    let(:result) { Easy::Api::Result.new }
+
+    subject(:parsed_json) { JSON.parse(result.to_json) }
+
+    context 'with basic result attributes' do
+      before do
+        result.success = true
+        result.customer =  "Bert O'Malley"
       end
 
-      context "json error" do
-        subject { result.as_json[:error] }
+      it "has a success key" do
+       expect(parsed_json).to have_key('success')
+      end
 
-        it "has an error" do
-         expect(subject.code).to eql api_error.code
-        end
+      it "is successful" do
+        expect(parsed_json['success']).to be(true)
+      end
 
-        it "has an error code" do
-          expect(subject.message).to eql api_error.message
-        end
+      it "has a customer key" do
+       expect(parsed_json).to have_key('customer')
+      end
 
+      it "has a customer name" do
+       expect(parsed_json['customer']).to eql "Bert O'Malley"
       end
     end
 
-    context "when result is successful" do
-
+    context 'with some RAW json attributes' do
       before do
         result.success = true
-        result.customer =  "Bob Loblaw"
+        result.raw.customer =  '{"name":"Geoff Flinders","age":27,"height": 1.79}'
       end
 
       it "has a success key" do
-       expect(subject).to have_key(:success)
+       expect(parsed_json).to have_key('success')
       end
 
       it "is successful" do
-        expect(subject[:success]).to be(true)
+        expect(parsed_json['success']).to be(true)
       end
 
       it "has a customer key" do
-       expect(subject).to have_key(:customer)
+        expect(parsed_json).to have_key('customer')
       end
 
-      it "has a customer name" do
-       expect(subject[:customer]).to eql "Bob Loblaw"
+      it "has a customer name key" do
+        expect(parsed_json['customer']).to have_key('name')
       end
 
-      it "has no status code" do
-        expect(subject).to_not have_key(:status_code)
+      it "has a customer name value" do
+        expect(parsed_json['customer']['name']).to eq('Geoff Flinders')
       end
 
-    end
+      it "has a customer age key" do
+        expect(parsed_json['customer']).to have_key('name')
+      end
 
+      it "has a customer age value" do
+        expect(parsed_json['customer']['age']).to eq(27)
+      end
+
+      it "has a customer height key" do
+        expect(parsed_json['customer']).to have_key('height')
+      end
+
+      it "has a customer height value" do
+        expect(parsed_json['customer']['height']).to eq(1.79)
+      end
+    end
   end
 
   describe "#status_code" do
@@ -95,9 +141,8 @@ describe Easy::Api::Result do
   end
 
   describe "#to_xml" do
-
     let(:result) { Easy::Api::Result.new }
-    subject { result.to_xml }
+    subject(:parsed_xml) { Hash.from_xml(result.to_xml) }
 
     context "when result is unsuccessful" do
       let(:api_error) { Easy::Api::Error.new(:unauthorized) }
@@ -106,25 +151,51 @@ describe Easy::Api::Result do
         result.error = api_error
       end
 
-      it "renders the object as " do
-        expect(subject).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <success>false</success>\n  <error>\n    <code>401</code>\n    <message>Unauthorized request</message>\n  </error>\n</response>\n")
+      it "includes the response.success value as false" do
+        expect(parsed_xml).to have_key('response')
+        expect(parsed_xml['response']).to have_key('success')
+        expect(parsed_xml['response']['success']).to eq('false')
       end
 
+      it "includes the response.error values" do
+        expect(parsed_xml).to eq({'response' => {'success' => 'false', 'error' => {'code' => '401', "message"=>"Unauthorized request"}}})
+      end
     end
 
     context "when result is successful" do
-
       before do
         result.success = true
         result.customer =  "Bob Loblaw"
       end
 
       it "renders the object as " do
-       expect(subject).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <customer>Bob Loblaw</customer>\n  <success>true</success>\n</response>\n")
+       expect(parsed_xml).to eql({'response' => {'customer' => 'Bob Loblaw', 'success' => 'true'}})
+      end
+    end
+
+    context "with some raw XML attributes" do
+      before do
+        result.success = true
+        result.rating = 'SUPER DUPER'
+        result.raw.customer =  "<name>Tristan</name><age>17</age><height>2.04</height>"
       end
 
+      it 'should render the result including the RAW attributes' do
+        expect(parsed_xml).to eq({'response' => {'success' => 'true', 'rating' => 'SUPER DUPER', 'customer' => {'name' => 'Tristan', 'age' => '17', 'height' => '2.04'}}})
+      end
     end
 
+    context 'with some nested attributes that match the root element name' do
+      before do
+        result.success = true
+        result.response = 'Funny'
+        result.raw.customer =  "<name>Charles</name>"
+      end
+
+      it 'should render the result including the RAW attributes' do
+        expect(parsed_xml).to eq({'response' => {'success' => 'true', 'response' => 'Funny', 'customer' => {'name' => 'Charles'}}})
+      end
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy-api
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Shevaun Coker
@@ -10,120 +10,134 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
 description: Enables consistent responses for API calls
 email:
 - shevaun.coker@abletech.co.nz
@@ -133,10 +147,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -165,17 +180,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Facilitates standard success and error behaviour in API responses