apitizer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d5476a8e3c80f3034bd2f27144d7f2fd997095
-  data.tar.gz: 483fda35af1d8363671a0aad567ce9a55334058a
+  metadata.gz: 40fc294404896c8bf5da7bcc98d9a1fb4888d559
+  data.tar.gz: 0f20b6555f17c71ed78843794b7b37c9b3e1abb8
 SHA512:
-  metadata.gz: ecb1d3880c1c46112e6ad3233ad60a49b112cc1d4c978200a6a69aa1923b217a95b25630503802ea3ae586ee3da8b6529d2ef61a075540ab0fc2f89efb06b3e3
-  data.tar.gz: 5503cfb3bbdb45bd32da4b028432a12f68d948da8caca486c559677fda7953631695867084963f2776ac9ba608da0bd8538b993eb4d540d56d3b5c93ff12ddfb
+  metadata.gz: 4a38a7ce97d22a84accc45630b5810a36875e300dcfb097c90ceb05ca809ce4b80122bdd54350d35972c2ec04789cd0f260c3355f003a598a7fc43bfea2000ec
+  data.tar.gz: 20a7a1afa6a79245ac342635422fcfae978f22f70b75651d9287a813b5bfb0f4057da601dea5d60b62f19c0253b9341de200b2f177088e77811931143f03e174

data/.gitignore

@@ -1,5 +1,7 @@
 .DS_Store
-*.swo
 *.swp
+*.swo
 *.gem
 Gemfile.lock
+doc
+.yardoc

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1,6 @@
+--markup-provider=redcarpet
+--markup=markdown
+lib/**/*.rb
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -1 +1,11 @@
+## Apitizer 0.0.2 (July 20, 2014)
+
+* A new strategy for searching request endpoints.
+* Support for `on: :collection` in addition to `on: :member`.
+* Support for `except: [ ... ]` in addition to `only: [ ... ]`.
+* Setting the Accept header according to the data format.
+* Sending the parameter of a POST/PUT/PATCH/DELETE request in its body.
+* Enforcing UTF-8 when sending HTTP requests.
+* Improved parameter encoding.
+
 ## Apitizer 0.0.1 (June 1, 2014)

data/Guardfile

@@ -1,7 +1,14 @@
 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]) }" }
+  watch(%r{^spec/.+_helper\.rb$}) { 'spec' }
+  watch(%r{^lib/(.+)\.rb$}) do |match|
+    result = "spec/#{ match[1] }_spec.rb"
+    loop do
+      break if File.exist?(result)
+      result = File.dirname(result)
+      break if result.empty?
+    end
+    result
+  end
 end
+# vim: ft=ruby

data/README.md

@@ -1,28 +1,91 @@
-# Apitizer
+# Apitizer [![Gem Version](https://badge.fury.io/rb/apitizer.svg)](http://badge.fury.io/rb/apitizer) [![Dependency Status](https://gemnasium.com/IvanUkhov/apitizer.svg)](https://gemnasium.com/IvanUkhov/apitizer) [![Build Status](https://travis-ci.org/IvanUkhov/apitizer.svg?branch=master)](https://travis-ci.org/IvanUkhov/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
 ```
 
+Note that the minimal supported version of Ruby is `2.1`.
+
 ## Usage
+
+Create an apitizer describing the API of the Web service you would like
+to interact with:
+
+```ruby
+apitizer = Apitizer::Base.new do
+  address 'https://service.com/api'
+
+  resources :posts do
+    resources :comments
+  end
+end
+```
+
+The apitizer can now be used to manipulate the resources provided by the
+Web service. To this end, there are five methods: `index`, `show`, `create`,
+`update`, and `delete`, which can be used as shown below.
+
+To list the members of a collection:
+
+```ruby
+apitizer.index(:posts)
+apitizer.index(:posts, post_id, :comments)
+```
+
+To read a member of a collection:
+
+```ruby
+apitizer.show(:posts, post_id)
+apitizer.show(:posts, post_id, :comments, comment_id)
+```
+
+To create a new member in a collection:
+
+```ruby
+apitizer.create(:posts, title: 'To be or not to be')
+apitizer.create(:posts, post_id, :comments, content: 'That is the question.')
+```
+
+To update a member of a collection:
+
+```ruby
+apitizer.update(:posts, post_id, title: 'What is the meaning of life?')
+apitizer.update(:posts, post_id, :comments, comment_id, content: '42.')
+```
+
+To delete a member of a collection:
+
+```ruby
+apitizer.delete(:posts, post_id)
+apitizer.delete(:posts, post_id, :comments, comment_id)
+```
+
+## Example
+
 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'
 
@@ -39,7 +102,7 @@ apitizer = Apitizer::Base.new(options) do
   address 'https://typekit.com/api/v1/json'
 
   resources :families, only: :show do
-    show ':variant', on: :member
+    show ':variation', on: :member
   end
 
   resources :kits do
@@ -55,6 +118,7 @@ puts JSON.pretty_generate(apitizer.index(:kits))
 ```
 
 Output:
+
 ```json
 {
   "kits": [
@@ -79,13 +143,16 @@ Output:
 ```
 
 ## 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
+1. [Fork](https://help.github.com/articles/fork-a-repo) the project.
+2. Create a branch for your feature (`git checkout -b awesome-feature`).
+3. Implement your feature (`vim`).
+4. Commit your changes (`git commit -am 'Implemented an awesome feature'`).
+5. Push to the branch (`git push origin awesome-feature`).
+6. [Create](https://help.github.com/articles/creating-a-pull-request)
+   a new Pull Request.

data/apitizer.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |spec|
   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' ]
 
@@ -26,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'guard-rspec', '~> 4.2'
   spec.add_development_dependency 'webmock', '~> 1.18'
 end

data/lib/apitizer.rb

@@ -6,7 +6,6 @@ require_relative 'apitizer/helper'
 
 require_relative 'apitizer/routing'
 require_relative 'apitizer/connection'
-require_relative 'apitizer/processing'
 
 require_relative 'apitizer/result'
 require_relative 'apitizer/base'

data/lib/apitizer/base.rb

@@ -1,5 +1,9 @@
 module Apitizer
   class Base
+    extend Forwardable
+
+    def_delegator :map, :define
+
     def initialize(**options, &block)
       @options = Helper.deep_merge(Apitizer.defaults, options)
       @block = block
@@ -8,8 +12,7 @@ module Apitizer
     def process(*arguments)
       request = build_request(*arguments)
       response = dispatcher.process(request)
-      content = translator.process(response)
-      Result.new(request: request, response: response, content: content)
+      Result.new(request: request, response: response)
     end
 
     Apitizer.actions.each do |action|
@@ -20,42 +23,28 @@ module Apitizer
 
     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)
+    def map
+      @map ||= Routing::Map.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)
+    def dispatcher
+      @dispatcher ||= Connection::Dispatcher.new(format: @options[:format],
+        adaptor: @options[:adaptor], headers: @options[:headers])
     end
 
     def build_request(*arguments)
-      action, steps, parameters = prepare(*arguments)
-      path = mapper.trace(action, steps)
-      Connection::Request.new(action: action, path: path,
+      action, method, steps, parameters = prepare(*arguments)
+      Connection::Request.new(method: method, path: map.trace(action, steps),
         parameters: parameters)
     end
 
     def prepare(action, *path)
+      action = action.to_sym
+      method = @options[:dictionary][action] or raise Error, 'Unknown action'
       parameters = path.last.is_a?(Hash) ? path.pop : {}
-      [ action.to_sym, path.flatten.map(&:to_sym), parameters ]
-    end
+      steps = path.flatten.map(&:to_sym)
 
-    def method_missing(name, *arguments, &block)
-      return @options[name] if @options.key?(name)
-      super
+      [ action, method, steps, parameters ]
     end
   end
 end

data/lib/apitizer/connection.rb

@@ -1,6 +1,8 @@
-require_relative 'connection/request'
+require_relative 'connection/format'
 require_relative 'connection/adaptor'
 require_relative 'connection/dispatcher'
+
+require_relative 'connection/request'
 require_relative 'connection/response'
 
 module Apitizer

data/lib/apitizer/connection/adaptor.rb

@@ -6,7 +6,7 @@ module Apitizer
       def self.build(name)
         self.const_get(name.to_s.capitalize).new
       rescue NameError
-        raise Error, 'Unknown connection adaptor'
+        raise Error, 'Unknown adaptor'
       end
     end
   end

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

@@ -6,13 +6,14 @@ module Apitizer
     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))
+          request = build_request(method, 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 ]
+          [ response.code.to_i, response.to_hash, Array(response.body) ]
         rescue NoMethodError
           raise
         rescue NameError
@@ -23,10 +24,26 @@ module Apitizer
 
         private
 
-        def build_uri(address, parameters)
-          chunks = [ address ]
-          chunks << Helper.build_query(parameters) unless parameters.empty?
-          URI(chunks.join('?'))
+        def build_request(method, address, parameters)
+          klass = Net::HTTP.const_get(method.to_s.capitalize)
+
+          return klass.new(URI(address)) if parameters.empty?
+
+          parameters = Helper.build_query(parameters)
+
+          if klass == Net::HTTP::Get
+            address = [ address, parameters ].join('?')
+            request = klass.new(URI(address))
+          else
+            request = klass.new(URI(address))
+            request.body = parameters
+            request['Content-Type'] = [
+              'application/x-www-form-urlencoded',
+              "charset=#{ parameters.encoding.to_s }"
+            ].join('; ')
+          end
+
+          request
         end
       end
     end

data/lib/apitizer/connection/dispatcher.rb

@@ -1,23 +1,16 @@
 module Apitizer
   module Connection
     class Dispatcher
-      def initialize(adaptor: :standard, dictionary:, headers: {})
+      def initialize(format:, adaptor: :standard, headers: {})
+        @format = Format.build(format)
         @adaptor = Adaptor.build(adaptor)
-        @dictionary = dictionary
-        @headers = headers
+        @headers = headers.merge('Accept' => @format.mime_type)
       end
 
       def process(request)
-        method = translate(request.action)
-        code, _, body = @adaptor.process(method, request.address,
+        code, _, body = @adaptor.process(request.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'
+        Response.new(code: code, content: @format.process(body.join))
       end
     end
   end

data/lib/apitizer/connection/format.rb

@@ -0,0 +1,14 @@
+require_relative 'format/json'
+require_relative 'format/yaml'
+
+module Apitizer
+  module Connection
+    module Format
+      def self.build(name)
+        self.const_get(name.to_s.upcase).new
+      rescue NameError
+        raise Error, 'Unknown format'
+      end
+    end
+  end
+end

data/lib/apitizer/{processing/parser → connection/format}/json.rb

@@ -1,9 +1,13 @@
 require 'json'
 
 module Apitizer
-  module Processing
-    module Parser
+  module Connection
+    module Format
       class JSON
+        def mime_type
+          'application/json'
+        end
+
         def process(data)
           ::JSON.parse(data)
         rescue

data/lib/apitizer/{processing/parser → connection/format}/yaml.rb

@@ -1,9 +1,13 @@
 require 'yaml'
 
 module Apitizer
-  module Processing
-    module Parser
+  module Connection
+    module Format
       class YAML
+        def mime_type
+          'application/x-yaml'
+        end
+
         def process(data)
           ::YAML.load(data)
         rescue