service_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba6978a7be8e0338599cebac7b88b19dd2c75820
+  data.tar.gz: 756d2a3a25c34a92f7cb5f89ac227472030413c4
+SHA512:
+  metadata.gz: 61642864e157207a38556f4f1178dc19bfb6928fb27e3167c07b56918e649cfc64b7804cc0ee7ea6ad27fdaa3c113e229cca03affbd0f651e5e4b56731a12575
+  data.tar.gz: cf12d4612c7b6f2b19c045ba0c4e89ba0d719fd0d92b123c91e80a5c46a85a4abb74eac4880f2fb61aeefe51de00f80c930979f585b92b6e69726d2e82a034d2

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Krzysztof Wawer
+
+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,29 @@
+# ServiceApi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'service_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/service_api/fork )
+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 @@
+require "bundler/gem_tasks"

data/lib/service_api.rb

@@ -0,0 +1,5 @@
+module ServiceApi; end
+
+require 'service_api/version'
+require 'service_api/base_faraday'
+require 'service_api/uri_tokens'

data/lib/service_api/base_faraday.rb

@@ -0,0 +1,109 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'uri_template'
+
+module ServiceApi
+  # BaseFaraday is module for Faraday api which should be included in own base Api class.
+  #
+  #   class MyApi
+  #     include BaseApi
+  #
+  #     private
+  #
+  #     def base_url
+  #       'http://example.com'
+  #     end
+  #   end
+  #
+  module BaseFaraday
+
+    # Initilizer require client class as parameter
+    #
+    #   MyApi.new(client)
+    #
+    def initialize(client)
+      @client = client
+      @params = {}
+      @mandatory_params = {}
+      @optional_params = {}
+    end
+
+    protected
+
+    # Available get, head, delete, post, put and patch method with path
+    # parameter. This method must be call as last method
+    #
+    #   path('/test/request').params(sample: true, api_key: 'abcd').get
+    #
+    %w[get head delete post put patch].each do |method|
+      define_method method do
+        connection.send(method, uri, query_params)
+      end
+    end
+
+    # Pass path to request
+    #
+    #   path('/test/request')
+    #
+    def path(path)
+      uri_tokens(path)
+      self
+    end
+
+    # Pass parameters to request
+    #
+    #   params(sample: true, api_key: 'abcd')
+    #
+    def params(options)
+      @params = options
+      self
+    end
+
+    # Last method called in chain which return full url request
+    #
+    #  path('/test/request').params(sample: true, api_key: 'abcd').url
+    #
+    def url
+      "#{base_url}#{uri}"
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: base_url) do |builder|
+        builder.response :xml,  content_type: /\bxml$/
+        builder.response :json, content_type: /\bjson$/
+
+        if @client.options[:adapter] == :test
+          builder.adapter @client.options[:adapter], @client.options[:adapter_options]
+        else
+          builder.adapter @client.options[:adapter]
+        end
+      end
+    end
+
+    def token?(value)
+      uri_tokens.token_values.include?(value.to_s)
+    end
+
+    def uri_tokens(uri = nil)
+      if uri
+        @uri_tokens = ServiceApi::UriTokens.new(uri)
+      else
+        @uri_tokens
+      end
+    end
+
+    def uri
+      uri_tokens.uri_template.expand(@params)
+    end
+
+    def query_params
+      @params.reject{ |request_params| token?(request_params) }
+    end
+
+    def base_url
+      raise NotImplementedError
+    end
+  end
+end

data/lib/service_api/uri_tokens.rb

@@ -0,0 +1,19 @@
+module ServiceApi
+  class UriTokens
+    attr_reader :uri_template
+
+    def initialize(uri_template)
+      @uri_template = URITemplate.new(uri_template)
+    end
+
+    def token_values
+      @token_values ||= tokens.map(&:variables).flatten
+    end
+
+    private
+
+    def tokens
+      @tokens ||= @uri_template.tokens.select{ |template| !template.variables.empty? }
+    end
+  end
+end

data/lib/service_api/version.rb

@@ -0,0 +1,3 @@
+module ServiceApi
+  VERSION = '0.0.1'
+end

data/service_api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'service_api'
+  spec.version       = ServiceApi::VERSION
+  spec.authors       = ['Krzysztof Wawer']
+  spec.email         = ['krzysztof.wawer@gmail.com']
+  spec.summary       = %q{Set of useful modules, classes for api gems}
+  spec.description   = %q{Set of useful modules, classes for api gems}
+  spec.homepage     = %q{http://github.com/wafcio/service_api}
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency 'faraday', '~> 0.9.0'
+  spec.add_runtime_dependency 'uri_template', '~> 0.7.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.9.1'
+  spec.add_runtime_dependency 'multi_xml', '~> 0.5.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14.1'
+end

data/spec/integrations/base_faraday_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+class Client
+  def options
+    { adapter: :test, adapter_options: faraday_stubs }
+  end
+
+  def faraday_stubs
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.get('/test/request?api_key=abcd&sample=true') { [200, {}, 'OK'] }
+    end
+  end
+end
+
+class MyApi
+  include ServiceApi::BaseFaraday
+
+  private
+
+  def base_url
+    'http://example.com'
+  end
+end
+
+class SampleApi < MyApi
+  def find
+    path('/test/request').params(sample: true, api_key: 'abcd').get
+  end
+
+  def find_url
+    path('/test/request').params(sample: true, api_key: 'abcd').url
+  end
+end
+
+describe ServiceApi::BaseFaraday do
+  let(:client) { Client.new }
+  let(:model) { SampleApi.new(client) }
+
+  it 'should return string' do
+    model.find.body.should == 'OK'
+  end
+
+  it 'should return full url' do
+    model.find_url.should == 'http://example.com/test/request'
+  end
+end

data/spec/integrations/uri_tokens_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe ServiceApi::UriTokens do
+  let(:template) { ServiceApi::UriTokens.new('http://{host}/{segments}/{file}.{extensions}') }
+
+  it 'should return token values' do
+    template.token_values.sort.should == ['extensions', 'file', 'host', 'segments']
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'service_api'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: service_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Krzysztof Wawer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Set of useful modules, classes for api gems
+email:
+- krzysztof.wawer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/service_api.rb
+- lib/service_api/base_faraday.rb
+- lib/service_api/uri_tokens.rb
+- lib/service_api/version.rb
+- service_api.gemspec
+- spec/integrations/base_faraday_spec.rb
+- spec/integrations/uri_tokens_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wafcio/service_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Set of useful modules, classes for api gems
+test_files:
+- spec/integrations/base_faraday_spec.rb
+- spec/integrations/uri_tokens_spec.rb
+- spec/spec_helper.rb