otis 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjNlNDM2YzIxMTJhOTU3M2QzMjRjMTFjM2ZiOGVhYjc3N2NmYTRmYw==
+  data.tar.gz: !binary |-
+    NWJmNjRiNDk0YmY3NTdkOTA5NzY2ZjEwOTAyYjk4NTczNGNkYzVjZg==
+SHA512:
+  metadata.gz: !binary |-
+    ZmZlYzU1M2E5MzYxYTg0MmI3NDI4MDBhMzBkNDcwZDUxM2IyNWQxNGRlMWNi
+    NDk1NThmYTVkMjIzNTM4MDZlMDM0YWJjYTBkYjdmNTJkZmNiZDhhZmY4ZmUz
+    NTMzMGFhMzY4ZmJlMGUyZTI4NTJlZDM3ZDRmNWRjMWRjNzk2YTc=
+  data.tar.gz: !binary |-
+    Yzg3NjgxYTc4YTJlN2MxZGU5Y2M4M2Y4YWE5NzkxN2RhYTgyMzQ3NzZlZjE5
+    MGE5NzZiMTM3YWZhOWYzMGM0OTFkZTJjNzRlZDk2ZTUxOWQzZDM0NWZlOTk0
+    YjhlOTc0ZmEzNzNjMGEzODJkYjE0ZjQwODNlODc1MzY4YzlkZmI=

data/README.md

@@ -32,10 +32,12 @@ Using the example of [US Zip webservice](https://github.com/tbueno/otis_uszip_ex
     })
 
 ### Client
-Otis offers a base Client class that handle the response and instantiates the response object accordingly.
+Otis offers a base Client class that handle the response and instantiates the response object accordingly. In the following example, a SOAP client is instantiated with the proper WSDL
 
     Otis::Client.new(routes, "http://www.webservicex.net/uszip.asmx?WSDL")
 
+HTTP clients can also be used as well
+
 ### Model
 
 The Client takes care of transforming the API response into a Hash. Having hashes, makes it easy to create response objects, called Otis::Model.

data/lib/otis.rb

@@ -6,8 +6,10 @@ module Otis
   require 'otis/hash_content'
   require 'otis/otis_object'
   require 'otis/model'
+  require 'otis/hooks'
   require 'otis/client'
   require 'otis/http_client'
   require 'otis/soap_client'
   require 'otis/map'
+  require 'otis/response'
 end

data/lib/otis/client.rb

@@ -1,12 +1,19 @@
 module Otis
   class Client
+    include Hooks
+
     protected
     # Tries to find the requested method in the routes map.
     # Send it to Object$method_missing if the desired route is not found
     def method_missing(meth, *args)
       klass = @routes[meth.to_sym]
       super unless klass
-      klass.new(call(meth, args))
+      if respond_to?("filter_for_#{meth}")
+        filter_meth = send("filter_for_#{meth}")
+        send(filter_meth, call(meth, *args))
+      else
+        klass.new(call(meth, *args))
+      end
     end
   end
 end

data/lib/otis/hooks.rb

@@ -0,0 +1,23 @@
+module Otis
+  module Hooks
+
+    def self.included(base)
+      base.extend(ClassExtension)
+    end
+
+    module ClassExtension
+      #
+      # Filter the response of a method with another method
+      #
+      def filter(meth, options = {})
+        meth = meth.to_s
+        class_eval %(
+          def filter_for_#{meth}
+            "#{options[:with]}"
+          end
+        )
+      end
+    end
+  end
+
+end

data/lib/otis/http_client.rb

@@ -12,9 +12,14 @@ module Otis
     end
 
     protected
-    def call(action, options)
-      response = @client.get "#{options.first}/#{action}", options.last
-      JSON.parse(response.body)
+    def call(action, url, options)
+      response = @client.get "#{url}", options, {'Content-Type' => 'application/json'}
+      respond(response)
+    end
+
+    #TODO: make it more robust
+    def respond(response)
+      response.status == 304 ? {} : JSON.parse(response.body).merge(headers: response.headers)
     end
 
     def create_client(url)

data/lib/otis/model.rb

@@ -1,7 +1,9 @@
 module Otis
   class Model
-    include Otis::Object
     include Virtus.model
+    include Otis::Object
     include HashContent
+
+    attributes :headers
   end
 end

data/lib/otis/otis_object.rb

@@ -10,11 +10,6 @@ module Otis
       attrs.each_pair do |k, v|
         m = underscore(k.to_s)
         self.send("#{m}=", v ) if self.respond_to?("#{m}=")
-      end if respond_to?(:decamelize?) and decamelize?
-      if respond_to?(:hooks)
-        hooks.each do |hook|
-          self.send(hook)
-        end
       end
     end
 
@@ -24,6 +19,19 @@ module Otis
           class_eval %(attr_accessor :#{m} )
         end
       end
+
+      def collection(opts ={})
+        collection = opts[:as].to_s
+        klass = opts[:of]
+        class_eval %(def #{collection}; @#{collection} ||= Array(@response['#{camelize(collection)}']).map{|c| #{klass}.new(c)}; end)
+      end
+
+      private
+      def camelize(string)
+        return string if string !~ /_/ && self =~ /[A-Z]+.*/
+        string.split('_').map{|e| e.capitalize}.join
+      end
+
     end
 
     private

data/lib/otis/response.rb

@@ -0,0 +1,4 @@
+module Otis
+  class Response < Otis::Model
+  end
+end

data/lib/otis/version.rb

@@ -1,3 +1,3 @@
 module Otis
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/otis.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "debugger"
+  spec.add_development_dependency "rspec"
 
   spec.add_dependency 'savon', '~> 2.2.0'
   spec.add_dependency 'faraday'

data/spec/lib/otis/client_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Otis::Hooks do
+
+
+  class TestClient < Otis::Client
+      filter :my_method, with: :my_filter
+      def initialize(routes); @routes = routes; end
+      def my_filter(content); content[:foo].upcase! ;end
+      def call(action, url, options)
+        {foo: 'bar'}
+      end
+    end
+
+  describe 'filter' do
+
+    let(:response) { double }
+
+    it 'executes filters with results of method' do
+      object = TestClient.new(my_method: response)
+      expect(object.my_method(double, double)).to eq('BAR')
+    end
+  end
+
+end

data/spec/lib/otis/hash_content_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Otis::HashContent do
+  describe 'accessor generation' do
+    let(:params) do {a: {b: {foo: 'bar'}}} end
+
+    class ComplexClass < Otis::Model
+      root_key to: [:a, :b]
+      attribute :foo, String
+    end
+
+    it 'creates an array to the root key' do
+      ComplexClass.new(params).path.should == [:a, :b]
+    end
+
+    it 'sets the root key' do
+      ComplexClass.new(params).foo.should == 'bar'
+    end
+  end
+
+  describe 'remaping root key name' do
+
+    let(:params) do {a: {b: {foo: 'bar'}}} end
+
+    class EvenMoreComplex < Otis::Model
+      root_key to: [:a, :b], as: 'baz'
+      attribute :baz, String
+    end
+
+    it 'response accordingly' do
+      EvenMoreComplex.new(params).baz.should == {foo: 'bar'}
+    end
+  end
+end

data/spec/lib/otis/http_client_spec.rb

@@ -23,7 +23,7 @@ describe Otis::HttpClient do
     let(:url) { 'http://api.site.com' }
 
     it 'instantiate a faraday client with endpoint url' do
-      Faraday.should_receive(:new).with(url: url)
+      expect(Faraday).to receive(:new).with(url: url)
       described_class.new(map, url)
     end
 
@@ -47,25 +47,28 @@ describe Otis::HttpClient do
 
   describe 'call' do
 
-    let(:faraday)   { double(get: response) }
-    let(:response) { double(body: "{\"my_call\": \"response\"}")}
-    let(:routes) { Otis::Map.new({my_call: ResponseClass}) }
+    let(:faraday)  { double(get: response)                                  }
+    let(:url)      { 'api/v1'                                               }
+    let(:params)   {       { param1: 'foo', param2: 'bar' }                 }
+    let(:response) { double(body: "{ \"my_call\": \"response\"}",
+                    status: 200, headers: {})                               }
+    let(:routes)   { Otis::Map.new({ my_call: ResponseClass } )             }
 
     before { Otis::HttpClient.any_instance.stub(create_client: faraday)}
 
     it 'forwards the call to the client' do
-      faraday.should_receive(:get).with("api/v1/my_call", {param1: 'foo', param2: 'bar'})
-      MyHttpClient.new(routes, 'url').my_call('api/v1', {param1: 'foo', param2: 'bar'})
+      expect(faraday).to receive(:get).with(url, params, {'Content-Type' => 'application/json'})
+      MyHttpClient.new(routes, 'url').my_call(url, params)
     end
 
     it 'returns response object' do
-      MyHttpClient.new(routes, 'url').my_call('api/v1', {param1: 'foo', param2: 'bar'})
-        .should be_a(ResponseClass)
+      expect(MyHttpClient.new(routes, 'url').my_call(url, params))
+        .to be_a(ResponseClass)
     end
 
     it 'passes the parsed response to response object' do
-      ResponseClass.should_receive(:new).with({'my_call' => 'response'})
-      MyHttpClient.new(routes, 'url').my_call('api/v1', {param1: 'foo', param2: 'bar'})
+      ResponseClass.should_receive(:new).with({'my_call' => 'response', :headers => {}})
+      MyHttpClient.new(routes, 'url').my_call(url, params)
     end
   end
 

data/spec/lib/otis/model_spec.rb

@@ -13,35 +13,4 @@ describe Otis::Model do
       end
     end
   end
-
-  describe 'accessor generation' do
-    let(:params) do {a: {b: {foo: 'bar'}}} end
-
-    class ComplexClass < Otis::Model
-      root_key to: [:a, :b]
-      attribute :foo, String
-    end
-
-    it 'creates an array to the root key' do
-      ComplexClass.new(params).path.should == [:a, :b]
-    end
-
-    it 'sets the root key' do
-      ComplexClass.new(params).foo.should == 'bar'
-    end
-  end
-
-  describe 'remaping root key name' do
-
-    let(:params) do {a: {b: {foo: 'bar'}}} end
-
-    class EvenMoreComplex < Otis::Model
-      root_key to: [:a, :b], as: 'baz'
-      attribute :baz, String
-    end
-
-    it 'response accordingly' do
-      EvenMoreComplex.new(params).baz.should == {foo: 'bar'}
-    end
-  end
 end

data/spec/lib/otis/otis_object_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Otis::Object do
+
+  describe 'collection' do
+    class Thing; end
+
+    class TestClass
+      include Otis::Object
+      collection of: Thing, as: :things
+    end
+    let(:klass) { TestClass.new }
+
+    it 'creates the get' do
+      expect(klass).to respond_to(:things)
+    end
+
+    it 'holds a collection' do
+      klass.things << Thing.new
+      klass.things << Thing.new
+      expect(klass.things.count).to eq(2)
+    end
+  end
+end

data/spec/lib/otis/soap_client_spec.rb

@@ -23,7 +23,7 @@ describe Otis::SoapClient do
     before { client.stub_chain(:call, :body).and_return(response) }
 
     it 'delegates the call the the client' do
-      client.should_receive(:call).with(:my_call, {params: []})
+      client.should_receive(:call).with(:my_call, [:params, []])
       MySoapClient.new(routes, double).my_call(params: [])
     end
 

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: otis
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Thiago Bueno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,20 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
@@ -62,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +90,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +104,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -123,44 +124,51 @@ files:
 - lib/otis.rb
 - lib/otis/client.rb
 - lib/otis/hash_content.rb
+- lib/otis/hooks.rb
 - lib/otis/http_client.rb
 - lib/otis/map.rb
 - lib/otis/model.rb
 - lib/otis/otis_object.rb
+- lib/otis/response.rb
 - lib/otis/soap_client.rb
 - lib/otis/version.rb
 - otis.gemspec
+- spec/lib/otis/client_spec.rb
+- spec/lib/otis/hash_content_spec.rb
 - spec/lib/otis/http_client_spec.rb
 - spec/lib/otis/model_spec.rb
+- spec/lib/otis/otis_object_spec.rb
 - spec/lib/otis/soap_client_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby Api wrapper framework
 test_files:
+- spec/lib/otis/client_spec.rb
+- spec/lib/otis/hash_content_spec.rb
 - spec/lib/otis/http_client_spec.rb
 - spec/lib/otis/model_spec.rb
+- spec/lib/otis/otis_object_spec.rb
 - spec/lib/otis/soap_client_spec.rb
 - spec/spec_helper.rb