geekier_factory 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 rules.io UG (haftungsbeschraenkt)
+
+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,4 @@
+geekier_factory_gem
+===================
+
+Ruby gem for using APIs, based on their Geekier API descriptions.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs = %w(lib test)
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/geekier_factory.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/geekier_factory/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "geekier_factory"
+  s.version     = GeekierFactory::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christian Weis", "David Anderson"]
+  s.email       = "team@rules.io"
+  s.homepage    = "http://github.com/rulesio/geekier_factory_gem"
+  s.summary     = "Generate API objects from swagger definition files"
+  s.description = "Generate API objects from swagger definition files"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "bundler", "~> 1"
+  s.add_development_dependency "test-unit", "~> 2.2"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "webmock"
+  
+  s.add_dependency "faraday"
+  s.add_dependency "faraday_middleware"
+  s.add_dependency "faraday_body_logger"
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end

data/lib/geekier_factory/action.rb

@@ -0,0 +1,83 @@
+module GeekierFactory  
+  class Action
+    def initialize(api, structure)
+      @api = api
+      @structure = structure
+    end
+    
+    def params
+      @structure['parameters']
+    end
+    
+    def body_params
+      params.select{ |p| p['paramType'] == 'body' }
+    end
+
+    def url_params
+      params.select{ |p| p['paramType'] == 'query' }
+    end
+
+    def url_hash(param_values)
+      names = url_params.map{ |p| p['name'] }
+      param_values.select{ |k,v| names.include?(k.to_s) }
+    end
+
+    def body_hash(param_values)
+      names = body_params.map{ |p| p['name'] }
+      param_values.select{ |k,v| names.include?(k.to_s) }
+    end
+
+    def build_url(param_values)
+      api_connection.build_url(path, url_hash(param_values))
+    end
+
+    def build_body(param_values)
+      body_hash(param_values)
+    end
+
+    def http_method
+      @structure['httpMethod']
+    end
+    
+    def path
+      @structure['path'].start_with?('/') ? @structure['path'][1..-1] : @structure['path']
+    end
+
+    def request_hash(param_values)
+      { 
+        :verb => http_method.downcase.to_sym,
+        :url => build_url(param_values),
+        :body => build_body(param_values)
+      }
+    end
+    
+    def api_connection
+      @api.api_connection
+    end
+
+    def call(param_values)
+      reqhash = request_hash(param_values)
+      response = api_connection.run_request(reqhash[:verb], reqhash[:url], reqhash[:body], reqhash[:headers])
+      handle_response!(response)
+      {:request => reqhash, :response => response}
+    rescue Retry => e
+      retry
+    end
+
+    Retry = Class.new(Exception)
+    ConnectionException = Class.new(Exception)
+    def handle_response!(response)
+      if @structure['errorResponses'].map{ |er| er['code'] }.include? response.status
+        ex = @structure['errorResponses'].select{ |er| er['code'] == response.status }
+        if ex['retry'] == true && (@retries ||= 0) < ex[  ]
+          @retries += 1
+          raise Retry.new
+        else
+          raise ConnectionException.new("#{ex[:reason]} (HTTP status code #{ex[:code]})")
+        end
+      elsif !response.success?
+        raise ConnectionException.new
+      end
+    end
+  end
+end

data/lib/geekier_factory/api.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_body_logger'
+
+module GeekierFactory  
+  class API
+    def initialize(structure)
+      @structure = structure
+      @actions = @structure['apis'].map{ |api| api['operations'].map{ |op| Action.new(self, op.merge('path' => api['path'])) } }.flatten
+    end
+
+    def log_body?
+      true
+    end
+
+    def api_connection
+      @connection ||= begin
+        Faraday.new(base_url, ssl: {verify: false}) do |builder|
+          builder.request :json
+          
+          # builder.request :oauth, credentials_hash.merge(oauth_consumer_credentials) if oauth? and oauth_consumer_credentials.present?
+          
+          builder.response :body_logger if log_body?
+          
+          builder.adapter Faraday.default_adapter
+        end
+      end
+    end
+    
+    def available_actions
+      @actions
+    end
+
+    def base_url
+      @structure['basePath'].end_with?('/') ? @structure['basePath'] : (@structure['basePath'] + '/')
+    end
+
+    # def oauth?
+    #   true
+    # end
+    # 
+    # def oauth_consumer_credentials
+    #   {:consumer_key => 'xxxx', :consumer_secret => 'xxxx'}
+    # end
+    # 
+    # def consumer
+    #   OAuth::Consumer.new(oauth_consumer_credentials[:consumer_key], oauth_consumer_credentials[:consumer_secret], :site => base_url)
+    # end
+  end
+end

data/lib/geekier_factory/resource.rb

@@ -0,0 +1,4 @@
+module GeekierFactory  
+  class Resource
+  end
+end

data/lib/geekier_factory/version.rb

@@ -0,0 +1,3 @@
+module GeekierFactory
+  VERSION = "0.0.1"
+end

data/lib/geekier_factory.rb

@@ -0,0 +1,10 @@
+require 'geekier_factory/api'
+require 'geekier_factory/action'
+
+module GeekierFactory
+  def self.factorize(filename_with_path)
+    description = File.read(filename_with_path)
+    structure = YAML.load(description)
+    API.new(structure)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+Bundler.require
+require "test/unit"
+# require "mocha"
+
+require "geekier_factory"

data/test/mock_definition.json

@@ -0,0 +1,54 @@
+{
+    "apis": [
+        {
+            "description": "test api", 
+            "operations": [
+                {
+                    "errorResponses": [
+                    ], 
+                    "httpMethod": "POST", 
+                    "nickname": "test call", 
+                    "parameters": [
+                        {
+                            "allowMultiple": false, 
+                            "dataType": "string", 
+                            "description": "first query parameter", 
+                            "name": "q1", 
+                            "paramType": "query", 
+                            "required": true
+                        }, 
+                        {
+                            "allowMultiple": false, 
+                            "dataType": "string", 
+                            "description": "second query parameter", 
+                            "name": "q2", 
+                            "paramType": "query", 
+                            "required": false
+                        },  
+                        {
+                            "allowMultiple": false, 
+                            "dataType": "string", 
+                            "description": "first body parameter", 
+                            "name": "b1", 
+                            "paramType": "body", 
+                            "required": true
+                        },
+                        {
+                            "allowMultiple": false, 
+                            "dataType": "string", 
+                            "description": "second body parameter", 
+                            "name": "b2", 
+                            "paramType": "body", 
+                            "required": false
+                        }
+                    ], 
+                    "summary": "Call to test the API"
+                }, 
+            ], 
+            "path": "/action.do"
+        }
+    ], 
+    "basePath": "http://localhost/api/v0.1",
+    "resourcePath": "", 
+    "swaggerVersion": "1.1"
+}

data/test/test_factory.rb

@@ -0,0 +1,37 @@
+require 'helper'
+require "webmock"
+
+class TestFactory < Test::Unit::TestCase
+  include WebMock::API
+  
+  setup do
+    @api = GeekierFactory.factorize(File.join(File.dirname(File.expand_path(__FILE__)), 'mock_definition.json'))
+    @action = @api.available_actions.first
+  end
+
+  test "api should be factorized" do
+    assert @api
+    assert @api.is_a? GeekierFactory::API
+  end
+
+  test "api should have one action" do
+    assert_equal 1, @api.available_actions.size
+  end
+
+  test "action should have 4 parameters" do
+    assert_equal 4, @action.params.size
+    assert_equal ['q1', 'q2', 'b1', 'b2'], @action.params.map{ |p| p['name'] }
+  end
+
+  test "action should have 2 body and 2 query parameters and they should be different" do
+    assert_equal 2, @action.body_params.size
+    assert_equal 2, @action.url_params.size
+    assert_not_equal @action.body_params, @action.url_params
+  end
+
+  test "calling the action should call the right url" do
+    stub_http_request(:post, "localhost/api/v0.1/action.do").
+      with(:body => {:b1 => "body", :b2 => "test"}, :query => {:q1 => 'testing', :q2 => 'query'})
+    @action.call(:b1 => "body", :b2 => "test", :q1 => 'testing', :q2 => 'query')
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: geekier_factory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Weis
+- David Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-28 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: 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: webmock
+  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: 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: faraday_middleware
+  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: faraday_body_logger
+  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: Generate API objects from swagger definition files
+email: team@rules.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- geekier_factory.gemspec
+- lib/geekier_factory.rb
+- lib/geekier_factory/action.rb
+- lib/geekier_factory/api.rb
+- lib/geekier_factory/resource.rb
+- lib/geekier_factory/version.rb
+- test/helper.rb
+- test/mock_definition.json
+- test/test_factory.rb
+homepage: http://github.com/rulesio/geekier_factory_gem
+licenses: []
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Generate API objects from swagger definition files
+test_files: []