otis 0.0.4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in skyscanner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thiago Bueno
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Otis
+
+API Wrapper Framework
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'otis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install otis
+
+## Usage
+
+### Map
+
+It all starts by describing the webservice/API that you would be interacting to by creating Otis::Map of entry points and response objects.
+
+Using the example of [US Zip webservice](https://github.com/tbueno/otis_uszip_example), this first step would be like this:
+
+    Otis::Map.new({
+      :get_info_by_zip => UsZip::InfoZipResponse,
+      :get_info_by_state => UsZip::InfoStateResponse,
+      :get_info_by_city => UsZip::InfoCityResponse,
+      :get_info_by_area_code => UsZip::InfoAreaCodeResponse
+    })
+
+### Client
+Otis offers a base Client class that handle the response and instantiates the response object accordingly.
+
+    Otis::Client.new(routes, "http://www.webservicex.net/uszip.asmx?WSDL")
+
+### 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.
+
+The main purpose of a Otis::Model is to wrap a hash into a object with helpful methods for dealing with inconsistence and other useful functionalities.
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/otis.rb

@@ -0,0 +1,13 @@
+require "otis/version"
+require "virtus"
+require "savon"
+require 'json'
+module Otis
+  require 'otis/hash_content'
+  require 'otis/otis_object'
+  require 'otis/model'
+  require 'otis/client'
+  require 'otis/http_client'
+  require 'otis/soap_client'
+  require 'otis/map'
+end

data/lib/otis/client.rb

@@ -0,0 +1,12 @@
+module Otis
+  class Client
+    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))
+    end
+  end
+end

data/lib/otis/hash_content.rb

@@ -0,0 +1,37 @@
+module Otis
+  # This module holds a collection of utilitie methods for Hash objects
+  #
+  module HashContent
+    def self.included(base)
+      base.extend(ClassExtension)
+    end
+
+    def initialize(attrs = {})
+      @response = root(attrs)
+      super(@response)
+    end
+
+    private
+    def root(attrs)
+      return attrs unless self.respond_to?(:path)
+      attrs = sub_tree(attrs)
+      if self.respond_to?(:new_root)
+        Hash[new_root.to_sym => attrs]
+      else
+        attrs
+      end
+    end
+
+    # Navigates in the Hash tree and return a subtree based on the path list
+    def sub_tree(attrs)
+      path.inject(attrs){ |res, el| res[el]}
+    end
+
+    module ClassExtension
+      def root_key(opts = {})
+        class_eval "def new_root; '#{opts[:as]}'; end " if opts[:as]
+        class_eval %( def path; #{opts[:to]}; end )
+      end
+    end
+  end
+end

data/lib/otis/http_client.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+
+module Otis
+  class HttpClient < Client
+    def initialize(map, url)
+      @routes = map.routes
+      @client = create_client(url)
+    end
+
+    def operations
+      @routes.keys
+    end
+
+    protected
+    def call(action, options)
+      response = @client.get "#{options.first}/#{action}", options.last
+      JSON.parse(response.body)
+    end
+
+    def create_client(url)
+      Faraday.new(:url => url) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :logger
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/otis/map.rb

@@ -0,0 +1,8 @@
+module Otis
+  class Map
+    attr_reader :routes
+    def initialize(routes)
+      @routes = routes
+    end
+  end
+end

data/lib/otis/model.rb

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

data/lib/otis/otis_object.rb

@@ -0,0 +1,39 @@
+module Otis
+  module Object
+
+    def self.included(base)
+      base.extend(ClassExtension)
+    end
+
+    def initialize(attrs = {})
+      @response = attrs
+      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
+
+    module ClassExtension
+      def attributes(*args)
+        args.each do |m|
+          class_eval %(attr_accessor :#{m} )
+        end
+      end
+    end
+
+    private
+    def underscore(string)
+      string.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+
+  end
+end

data/lib/otis/soap_client.rb

@@ -0,0 +1,18 @@
+module Otis
+  class SoapClient < Client
+    def initialize(map, wsdl)
+      @routes = map.routes
+      @client = Savon.client(wsdl: wsdl)
+    end
+
+    def operations
+      @client.operations
+    end
+
+    protected
+    def call(action, options)
+      soap_response = @client.call(action, options.first).body
+      soap_response
+    end
+  end
+end

data/lib/otis/version.rb

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

data/otis.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'otis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "otis"
+  spec.version       = Otis::VERSION
+  spec.authors       = ["Thiago Bueno"]
+  spec.email         = ["tbueno@tbueno.com"]
+  spec.description   = %q{A Ruby Api wrapper framework}
+  spec.summary       = %q{A Ruby Api wrapper framework}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "debugger"
+
+  spec.add_dependency 'savon', '~> 2.2.0'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'virtus'
+end

data/spec/lib/otis/http_client_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Otis::HttpClient do
+
+  class MyHttpClient < Otis::HttpClient
+  end
+  class ResponseClass; def initialize(string); end; end
+
+  let(:map) do
+    Otis::Map.new({
+      :op1 => ResponseClass,
+      :op2 => double
+    })
+  end
+
+  describe 'operations' do
+    it 'maps the allowed entrypoints' do
+      expect(described_class.new(map, 'url').operations).to eq([:op1, :op2])
+    end
+  end
+
+  describe 'create client' do
+    let(:url) { 'http://api.site.com' }
+
+    it 'instantiate a faraday client with endpoint url' do
+      Faraday.should_receive(:new).with(url: url)
+      described_class.new(map, url)
+    end
+
+    describe 'default options' do
+
+      after :each do described_class.new(map, url) end
+
+      it 'sets the request type' do
+        Faraday::Connection.any_instance.should_receive(:request).with(:url_encoded)
+      end
+
+      it 'sets response output' do
+        Faraday::Connection.any_instance.should_receive(:response).with(:logger)
+      end
+
+      it 'sets adapter' do
+        Faraday::Connection.any_instance.should_receive(:adapter).with(Faraday.default_adapter)
+      end
+    end
+  end
+
+  describe 'call' do
+
+    let(:faraday)   { double(get: response) }
+    let(:response) { double(body: "{\"my_call\": \"response\"}")}
+    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'})
+    end
+
+    it 'returns response object' do
+      MyHttpClient.new(routes, 'url').my_call('api/v1', {param1: 'foo', param2: 'bar'})
+        .should 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'})
+    end
+  end
+
+end

data/spec/lib/otis/model_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Otis::Model do
+
+  describe 'initialization' do
+    class SimpleClass < Otis::Model
+      attribute :my_key, String
+    end
+
+    describe 'with attributes' do
+      it 'creates the attribute getter' do
+        expect(SimpleClass.new({my_key: 'value'}).my_key).to eql('value')
+      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/soap_client_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Otis::SoapClient do
+
+  class MySoapClient < Otis::SoapClient
+  end
+  class ResponseClass; def initialize(response); end; end
+
+  let(:client)   { double(operations: [:op1, :op2])}
+  let(:routes) { Otis::Map.new({my_call: ResponseClass}) }
+
+  before { Savon.stub(client: client) }
+
+  describe 'operations' do
+    it 'maps the allowed from client' do
+      expect(described_class.new(routes, double).operations).to eq([:op1, :op2])
+    end
+  end
+
+  describe 'call' do
+    let(:response) { {my_call: 'response'}}
+
+    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: []})
+      MySoapClient.new(routes, double).my_call(params: [])
+    end
+
+    it 'returns response object' do
+      MySoapClient.new(routes, double).my_call(params: []).should be_a(ResponseClass)
+    end
+
+    it 'passes the attributes to response object' do
+      ResponseClass.should_receive(:new).with(response)
+      MySoapClient.new(routes, double).my_call(params: [])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path('../../lib/otis.rb', __FILE__)

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: otis
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Thiago Bueno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby Api wrapper framework
+email:
+- tbueno@tbueno.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/otis.rb
+- lib/otis/client.rb
+- lib/otis/hash_content.rb
+- lib/otis/http_client.rb
+- lib/otis/map.rb
+- lib/otis/model.rb
+- lib/otis/otis_object.rb
+- lib/otis/soap_client.rb
+- lib/otis/version.rb
+- otis.gemspec
+- spec/lib/otis/http_client_spec.rb
+- spec/lib/otis/model_spec.rb
+- spec/lib/otis/soap_client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: A Ruby Api wrapper framework
+test_files:
+- spec/lib/otis/http_client_spec.rb
+- spec/lib/otis/model_spec.rb
+- spec/lib/otis/soap_client_spec.rb
+- spec/spec_helper.rb