apitizer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77d5476a8e3c80f3034bd2f27144d7f2fd997095
+  data.tar.gz: 483fda35af1d8363671a0aad567ce9a55334058a
+SHA512:
+  metadata.gz: ecb1d3880c1c46112e6ad3233ad60a49b112cc1d4c978200a6a69aa1923b217a95b25630503802ea3ae586ee3da8b6529d2ef61a075540ab0fc2f89efb06b3e3
+  data.tar.gz: 5503cfb3bbdb45bd32da4b028432a12f68d948da8caca486c559677fda7953631695867084963f2776ac9ba608da0bd8538b993eb4d540d56d3b5c93ff12ddfb

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.swo
+*.swp
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1 @@
+## Apitizer 0.0.1 (June 1, 2014)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{ m[1] }_spec.rb" }
+  watch(%r{^lib/(.*\.rb)$}) { |m| "spec/#{ File.dirname(m[1]) }" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright 2014 Ivan Ukhov
+
+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,91 @@
+# Apitizer
+The main ingredient of a RESTful API client.
+
+## Installation
+Add the following line to your `Gemfile`:
+```ruby
+gem 'apitizer'
+```
+
+Then execute:
+```bash
+$ bundle
+```
+
+Alternatively, you can install the gem manually:
+```bash
+$ gem install apitizer
+```
+
+## Usage
+Here is an example for the [Typekit API](https://typekit.com/docs/api).
+Check out [Typekit Client](https://github.com/IvanUkhov/typekit-client)
+as well.
+
+Code:
+```ruby
+require 'apitizer'
+
+options = {
+  # Format
+  format: :json,
+  # Authorization
+  headers: { 'X-Typekit-Token' => ENV['tk_token'] },
+  # Non-standard REST-HTTP mapping
+  dictionary: { update: :post }
+}
+
+apitizer = Apitizer::Base.new(options) do
+  address 'https://typekit.com/api/v1/json'
+
+  resources :families, only: :show do
+    show ':variant', on: :member
+  end
+
+  resources :kits do
+    resources :families, only: [ :show, :update, :delete ]
+    show :published, on: :member
+    update :publish, on: :member
+  end
+
+  resources :libraries, only: [ :index, :show ]
+end
+
+puts JSON.pretty_generate(apitizer.index(:kits))
+```
+
+Output:
+```json
+{
+  "kits": [
+    {
+      "id": "bas4cfe",
+      "link": "/api/v1/json/kits/bas4cfe"
+    },
+    {
+      "id": "sfh6bkj",
+      "link": "/api/v1/json/kits/sfh6bkj"
+    },
+    {
+      "id": "kof8zcn",
+      "link": "/api/v1/json/kits/kof8zcn"
+    },
+    {
+      "id": "zyx4wop",
+      "link": "/api/v1/json/kits/zyx4wop"
+    }
+  ]
+}
+```
+
+## History
+Apitizer was a part of
+[Typekit Client](https://github.com/IvanUkhov/typekit-client).
+
+## Contributing
+
+1. Fork it ( https://github.com/IvanUkhov/apitizer/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/apitizer.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'apitizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'apitizer'
+  spec.version       = Apitizer::VERSION
+  spec.authors       = [ 'Ivan Ukhov' ]
+  spec.email         = [ 'ivan.ukhov@gmail.com' ]
+  spec.summary       = 'The main ingredient of a RESTful API client'
+  spec.description   = 'A Ruby library that provides a flexible engine ' \
+                       'for developing RESTful API clients.'
+  spec.homepage      = 'https://github.com/IvanUkhov/apitizer'
+  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{^spec/})
+  spec.require_paths = [ 'lib' ]
+
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.add_dependency 'rack', '~> 1.5'
+  spec.add_dependency 'json', '~> 1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2'
+  spec.add_development_dependency 'webmock', '~> 1.18'
+end

data/lib/apitizer.rb

@@ -0,0 +1,14 @@
+require 'delegate'
+require 'forwardable'
+
+require_relative 'apitizer/core'
+require_relative 'apitizer/helper'
+
+require_relative 'apitizer/routing'
+require_relative 'apitizer/connection'
+require_relative 'apitizer/processing'
+
+require_relative 'apitizer/result'
+require_relative 'apitizer/base'
+
+require_relative 'apitizer/version'

data/lib/apitizer/base.rb

@@ -0,0 +1,61 @@
+module Apitizer
+  class Base
+    def initialize(**options, &block)
+      @options = Helper.deep_merge(Apitizer.defaults, options)
+      @block = block
+    end
+
+    def process(*arguments)
+      request = build_request(*arguments)
+      response = dispatcher.process(request)
+      content = translator.process(response)
+      Result.new(request: request, response: response, content: content)
+    end
+
+    Apitizer.actions.each do |action|
+      define_method(action) do |*arguments|
+        process(action, *arguments)
+      end
+    end
+
+    private
+
+    [ :mapper, :dispatcher, :translator ].each do |component|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def #{ component }
+          @#{ component } ||= build_#{ component }
+        end
+      METHOD
+    end
+
+    def build_mapper
+      Routing::Mapper.new(&@block)
+    end
+
+    def build_dispatcher
+      Connection::Dispatcher.new(adaptor: self.adaptor,
+        dictionary: self.dictionary, headers: self.headers)
+    end
+
+    def build_translator
+      Processing::Translator.new(format: self.format)
+    end
+
+    def build_request(*arguments)
+      action, steps, parameters = prepare(*arguments)
+      path = mapper.trace(action, steps)
+      Connection::Request.new(action: action, path: path,
+        parameters: parameters)
+    end
+
+    def prepare(action, *path)
+      parameters = path.last.is_a?(Hash) ? path.pop : {}
+      [ action.to_sym, path.flatten.map(&:to_sym), parameters ]
+    end
+
+    def method_missing(name, *arguments, &block)
+      return @options[name] if @options.key?(name)
+      super
+    end
+  end
+end

data/lib/apitizer/connection.rb

@@ -0,0 +1,10 @@
+require_relative 'connection/request'
+require_relative 'connection/adaptor'
+require_relative 'connection/dispatcher'
+require_relative 'connection/response'
+
+module Apitizer
+  module Connection
+    Error = Class.new(Apitizer::Error)
+  end
+end

data/lib/apitizer/connection/adaptor.rb

@@ -0,0 +1,13 @@
+require_relative 'adaptor/standard'
+
+module Apitizer
+  module Connection
+    module Adaptor
+      def self.build(name)
+        self.const_get(name.to_s.capitalize).new
+      rescue NameError
+        raise Error, 'Unknown connection adaptor'
+      end
+    end
+  end
+end

data/lib/apitizer/connection/adaptor/standard.rb

@@ -0,0 +1,34 @@
+require 'net/https'
+require 'uri'
+
+module Apitizer
+  module Connection
+    module Adaptor
+      class Standard
+        def process(method, address, parameters = {}, headers = {})
+          klass = Net::HTTP.const_get(method.to_s.capitalize)
+          request = klass.new(build_uri(address, parameters))
+          headers.each { |k, v| request[k] = v }
+          http = Net::HTTP.new(request.uri.host, request.uri.port)
+          http.use_ssl = true if address =~ /^https:/
+          response = http.request(request)
+          [ response.code, response.to_hash, response.body ]
+        rescue NoMethodError
+          raise
+        rescue NameError
+          raise Error, 'Invalid method'
+        rescue SocketError
+          raise Error, 'Connection failed'
+        end
+
+        private
+
+        def build_uri(address, parameters)
+          chunks = [ address ]
+          chunks << Helper.build_query(parameters) unless parameters.empty?
+          URI(chunks.join('?'))
+        end
+      end
+    end
+  end
+end

data/lib/apitizer/connection/dispatcher.rb

@@ -0,0 +1,24 @@
+module Apitizer
+  module Connection
+    class Dispatcher
+      def initialize(adaptor: :standard, dictionary:, headers: {})
+        @adaptor = Adaptor.build(adaptor)
+        @dictionary = dictionary
+        @headers = headers
+      end
+
+      def process(request)
+        method = translate(request.action)
+        code, _, body = @adaptor.process(method, request.address,
+          request.parameters, @headers)
+        Response.new(code: code.to_i, body: body)
+      end
+
+      private
+
+      def translate(action)
+        @dictionary[action] or raise Error, 'Unknown action'
+      end
+    end
+  end
+end

data/lib/apitizer/connection/request.rb

@@ -0,0 +1,16 @@
+module Apitizer
+  module Connection
+    class Request
+      extend Forwardable
+
+      attr_reader :action, :path, :parameters
+      def_delegator :path, :address
+
+      def initialize(action:, path:, parameters: {})
+        @action = action
+        @path = path
+        @parameters = parameters
+      end
+    end
+  end
+end

data/lib/apitizer/connection/response.rb

@@ -0,0 +1,12 @@
+module Apitizer
+  module Connection
+    class Response
+      attr_reader :code, :body
+
+      def initialize(code:, body:)
+        @code = code
+        @body = body
+      end
+    end
+  end
+end

data/lib/apitizer/core.rb

@@ -0,0 +1,24 @@
+module Apitizer
+  Error = Class.new(StandardError)
+
+  @defaults = {
+    format: :json,
+    adaptor: :standard,
+    dictionary: {
+      :index => :get,
+      :show => :get,
+      :create => :post,
+      :update => :put,
+      :delete => :delete
+    },
+    headers: {}
+  }.freeze
+
+  @actions = [ :index, :show, :create, :update, :delete ].freeze
+  @collection_actions = [ :index, :create ].freeze
+  @member_actions = [ :show, :update, :delete ].freeze
+
+  singleton_class.class_eval do
+    attr_reader :defaults, :actions, :collection_actions, :member_actions
+  end
+end

data/lib/apitizer/helper.rb

@@ -0,0 +1,46 @@
+require 'rack/utils'
+
+module Apitizer
+  module Helper
+    Error = Class.new(Apitizer::Error)
+
+    def self.member_action?(action)
+      if Apitizer.member_actions.include?(action)
+        true
+      elsif Apitizer.collection_actions.include?(action)
+        false
+      else
+        raise Error, 'Unknown action'
+      end
+    end
+
+    def self.deep_merge(one, two)
+      merger = Proc.new do |key, v1, v2|
+        Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2
+      end
+      one.merge(two, &merger)
+    end
+
+    def self.build_query(parameters)
+      Rack::Utils.build_nested_query(prepare_parameters(parameters))
+    end
+
+    private
+
+    def self.prepare_parameters(parameters)
+      # PATCH: https://github.com/rack/rack/issues/557
+      Hash[
+        parameters.map do |key, value|
+          case value
+          when Integer, TrueClass, FalseClass
+            [ key, value.to_s ]
+          when Hash
+            [ key, prepare_parameters(value) ]
+          else
+            [ key, value ]
+          end
+        end
+      ]
+    end
+  end
+end