commute 0.2.0.rc.2 → 0.3.0.pre

data/spec/commute/extensions/url_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'commute/core/context'
+require 'commute/core/http'
+require 'commute/extensions/url'
+
+describe Commute::Extension::Url do
+
+  class TestApi < Commute::Api
+    include Commute::Extension::Url
+  end
+
+  class TestApiClass < Commute::Api
+    include Commute::Extension::Url
+    url 'http://www.example.com'
+  end
+
+  let(:request) { Commute::Http::Request.new nil }
+
+  it 'should be available both on class and instance level' do
+    TestApi.builder.respond_to?(:url).must_equal true
+    TestApi.new.respond_to?(:url).must_equal true
+  end
+
+  it 'should work on class level' do
+    TestApiClass.builder.transformations.size.must_equal 1
+    TestApiClass.new.transformations.size.must_equal 1
+  end
+
+  it 'should create an url transformation without parameters' do
+    transformation = example('http://api.example.com')
+    # Hash that acts as a context.
+    context = Commute::Context.new
+    transformation.call(request, context)
+    # Checks.
+    request.uri.scheme.must_equal 'http'
+    request.uri.host.must_equal 'api.example.com'
+    request.uri.path.must_be_empty
+  end
+
+  it 'should create an url transformation with parameters in the host and path' do
+    transformation = example('https://api.%{root}.com:3000/1/%{scope}/%{id}.xml')
+    # Hash that acts as a context.
+    context = Commute::Context.new(nil, {
+      root: 'example',
+      scope: 'people',
+      id: '3'
+    })
+    transformation.call(request, context)
+    # Checks.
+    request.uri.scheme.must_equal 'https'
+    request.uri.host.must_equal 'api.example.com'
+    request.uri.path.must_equal '/1/people/3.xml'
+    request.uri.port.must_equal 3000
+  end
+
+  it 'should create an url transformation with parameters in the host and path when only some of the values are present' do
+    transformation = example('https://api.%{root}.com:3000/1/%{scope}/%{id}.xml')
+    # Hash that acts as a context.
+    context = Commute::Context.new(nil, {
+      root: 'example',
+      scope: 'people'
+    })
+    transformation.call(request, context)
+    # Checks.
+    request.uri.scheme.must_equal 'https'
+    request.uri.host.must_equal 'api.example.com'
+    request.uri.path.must_equal '/1/people.xml'
+    request.uri.port.must_equal 3000
+  end
+
+  private
+
+  def example pattern
+    TestApi.new(Commute::Context.new).url(pattern).transformations.first
+  end
+end

data/spec/spec_helper.rb

@@ -6,8 +6,10 @@ SimpleCov.start
 require 'minitest/autorun'
 require 'minitest/spec'
 
+require 'webmock/minitest'
+
 require 'dominance/minitest'
 
-require 'mocha'
+require 'mocha/setup'
 
 require 'commute'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commute
 version: !ruby/object:Gem::Version
-  version: 0.2.0.rc.2
+  version: 0.3.0.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.5.0.rc
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.5.0.rc
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
@@ -35,7 +35,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  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
@@ -76,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -108,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -124,7 +140,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -140,7 +156,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -156,7 +172,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -187,48 +203,43 @@ files:
 - README.md
 - Rakefile
 - commute.gemspec
-- examples/gist_api.rb
-- examples/highrise_task_api.rb
-- examples/pastie_api.rb
 - lib/commute.rb
-- lib/commute/aspects/caching.rb
-- lib/commute/aspects/crud.rb
-- lib/commute/aspects/pagination.rb
-- lib/commute/aspects/url.rb
 - lib/commute/common/basic_auth.rb
-- lib/commute/common/cache.rb
+- lib/commute/common/caching.rb
 - lib/commute/common/chemicals.rb
-- lib/commute/common/conditional.rb
-- lib/commute/common/em-synchrony_adapter.rb
-- lib/commute/common/em_http_request_adapter.rb
+- lib/commute/common/eventmachine.rb
 - lib/commute/common/json.rb
-- lib/commute/common/typhoeus_adapter.rb
-- lib/commute/common/xml.rb
+- lib/commute/common/synchrony.rb
+- lib/commute/common/typhoeus.rb
 - lib/commute/configuration.rb
 - lib/commute/core/api.rb
 - lib/commute/core/builder.rb
-- lib/commute/core/commuter.rb
 - lib/commute/core/context.rb
-- lib/commute/core/processors/code_status_processor.rb
-- lib/commute/core/processors/hook.rb
-- lib/commute/core/processors/request_builder.rb
-- lib/commute/core/processors/sequencer.rb
-- lib/commute/core/request.rb
-- lib/commute/core/response.rb
+- lib/commute/core/http.rb
+- lib/commute/core/layer.rb
 - lib/commute/core/sequence.rb
 - lib/commute/core/stack.rb
+- lib/commute/core/status.rb
+- lib/commute/core/util/event_emitter.rb
+- lib/commute/core/util/path.rb
+- lib/commute/core/util/stream.rb
+- lib/commute/extensions/crud.rb
+- lib/commute/extensions/param.rb
+- lib/commute/extensions/url.rb
 - lib/commute/version.rb
-- spec/commute/aspects/caching_spec.rb
-- spec/commute/aspects/url_spec.rb
+- spec/commute/common/caching_spec.rb
+- spec/commute/common/eventmachine_spec.rb
+- spec/commute/common/typhoeus_spec.rb
 - spec/commute/core/api_spec.rb
 - spec/commute/core/builder_spec.rb
-- spec/commute/core/commuter_spec.rb
-- spec/commute/core/processors/code_status_processor_spec.rb
-- spec/commute/core/processors/hook_spec.rb
-- spec/commute/core/processors/request_builder_spec.rb
-- spec/commute/core/processors/sequencer_spec.rb
+- spec/commute/core/http_spec.rb
+- spec/commute/core/layer_spec.rb
 - spec/commute/core/sequence_spec.rb
 - spec/commute/core/stack_spec.rb
+- spec/commute/core/util/event_emitter_spec.rb
+- spec/commute/core/util/path_spec.rb
+- spec/commute/core/util/stream_spec.rb
+- spec/commute/extensions/url_spec.rb
 - spec/spec_helper.rb
 homepage: http://challengee.github.com/commute/
 licenses: []
@@ -257,16 +268,18 @@ summary: ! 'Commute helps you to: 1) Dynamically build HTTP requests for your fa
   HTTP library (currently only Typhoeus). 2) Easily process request and response bodies.
   3) Execute parallel HTTP requests.'
 test_files:
-- spec/commute/aspects/caching_spec.rb
-- spec/commute/aspects/url_spec.rb
+- spec/commute/common/caching_spec.rb
+- spec/commute/common/eventmachine_spec.rb
+- spec/commute/common/typhoeus_spec.rb
 - spec/commute/core/api_spec.rb
 - spec/commute/core/builder_spec.rb
-- spec/commute/core/commuter_spec.rb
-- spec/commute/core/processors/code_status_processor_spec.rb
-- spec/commute/core/processors/hook_spec.rb
-- spec/commute/core/processors/request_builder_spec.rb
-- spec/commute/core/processors/sequencer_spec.rb
+- spec/commute/core/http_spec.rb
+- spec/commute/core/layer_spec.rb
 - spec/commute/core/sequence_spec.rb
 - spec/commute/core/stack_spec.rb
+- spec/commute/core/util/event_emitter_spec.rb
+- spec/commute/core/util/path_spec.rb
+- spec/commute/core/util/stream_spec.rb
+- spec/commute/extensions/url_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/examples/gist_api.rb

@@ -1,71 +0,0 @@
-require 'commute'
-require 'commute/common/json'
-require 'commute/common/basic_auth'
-
-class GistApi < Commute::Api
-
-  transform do |request, context|
-    if context[:auth][:username]
-      request.url = "https://api.github.com/gists"
-    else
-      request.url = "https://api.github.com/#{context[:auth][:username]}/gists"
-    end
-    request.url << "/#{context[:id]}" if context[:id]
-  end
-
-  using(:request) do
-    append Commute::Common::Json::Render.new
-    append Commute::Common::BasicAuth.new
-  end
-
-  using(:response) do
-    append Commute::Common::Json::Parse.new
-  end
-
-  def find id = nil
-    # Id for url.
-    where id: id if id
-    # Get method.
-    get
-  end
-
-  def update gist = nil
-    body(gist).patch
-  end
-
-  def create gist = nil
-    body(gist).post
-  end
-
-  private
-
-  def body gist = nil
-    with gist: gist if gist
-    transform(:gist) { |request, gist| request.body = gist }
-  end
-end
-
-ID = '46ecd83c5e13cca5a18e'
-
-api = GistApi.with auth: {
-  username: 'challengee',
-  password: 'challengeez0'
-}
-
-# gist, status = api.find(ID).run
-# p status
-
-# gist[:description] = 'cool'
-
-gist = {
-  :public => false
-  :files => {
-    "file1.txt" => {
-      :content => 'test'
-    }
-  }
-}
-
-gist, status = api.create(gist).run
-p gist
-p status

data/examples/highrise_task_api.rb

@@ -1,59 +0,0 @@
-require 'uri'
-
-require 'commute'
-
-require 'commute/aspects/url'
-require 'commute/aspects/crud'
-require 'commute/common/basic_auth'
-
-require 'active_support/core_ext/hash/conversions'
-
-class HighriseTaskApi < Commute::Api
-  include Commute::Aspect::Url
-  include Commute::Aspect::Crud
-
-  using(:request) do
-    append Proc.new { |c|
-      c.get.body = c.get.body.to_xml(root: 'task').gsub("\n", '') if c.get.body
-    }
-    append Commute::Common::BasicAuth.new
-  end
-
-  using(:response) do
-    # append Proc.new { |c|
-    #   c.get.body = Array.from_xml(c.get.body)['tasks'] if c.get.body
-    # }
-  end
-
-  url 'https://$account.highrisehq.com/$scope/tasks/$id.xml'
-
-  transform(:task) do |request, context|
-    request.body = context[:task]
-  end
-  # transform :task => :body
-
-  transform { |request| request.headers['Content-Type'] = 'application/xml' }
-
-  def update task = nil
-    super.transform { |request| request.query['reload'] = 'true' }
-  end
-end
-
-api = HighriseTaskApi.with account: 'piepetest', auth: {
-  username: '610bf60020bb861761f07feef88ba42d',
-  password: 'X'
-}
-
-task = {
-  body: 'Kmoe iets doen'
-}
-
-task, status = api.all.run
-p task.size
-p status
-
-p 'AGAIN ------------------'
-
-task, status = api.all.run
-p task.size
-p status

data/examples/pastie_api.rb

@@ -1,18 +0,0 @@
-require 'commute'
-
-class PastieApi < Commute::Api
-
-  transform(:id) do |request, id|
-    request.url = "http://pastie.org/pastes/#{id}/download"
-  end
-
-  def find id = nil
-    # Id for url.
-    where id: id if id
-    # Get method.
-    get
-  end
-end
-
-pastie, status = PastieApi.find(5119067).run.data
-# p pastie

data/lib/commute/aspects/caching.rb

@@ -1,37 +0,0 @@
-require 'commute/common/cache'
-require 'commute/common/conditional'
-
-module Commute
-  module Aspect
-
-    # Public: Enables caching in your api by inserting
-    # cache processors in the api stack.
-    #
-    # Requires you to have a processor called request, before
-    # which the fetch processor will be inserted.
-    #
-    module Caching
-
-      def self.included api
-        # Insert a processor that fetches response from the cache.
-        api.builder.using(:request) do
-          insert Common::Cache::Fetch.new
-        end
-
-        # Insert a processor that inserts responses in the cache.
-        api.builder.using(:response) do
-          append Common::Cache::Store.new
-        end
-
-        # Wrap some phases so that they will only be executed on a miss.
-        api.builder.using do
-          [:execution, :response, :status].each do |id|
-            sequence.replace id do |processor|
-              Common::Conditional::NotTagged.new(processor, :hit)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/commute/aspects/crud.rb

@@ -1,41 +0,0 @@
-module Commute
-  module Aspect
-
-    module Crud
-
-      def self.included base
-        base.builder.transform(:body) do |request, resource|
-          request.body = resource
-        end
-      end
-
-      def all
-        get.multiple
-      end
-
-      def find id = nil
-        get.where(id: id).single
-      end
-
-      def update body = nil
-        put.with(body: body).single
-      end
-
-      def create body = nil
-        post.with(body: body).single
-      end
-
-      def destroy id = nil
-        delete.where(id: id).single
-      end
-
-      def single
-        self
-      end
-
-      def multiple
-        self
-      end
-    end
-  end
-end

data/lib/commute/aspects/pagination.rb

@@ -1,16 +0,0 @@
-module Commute
-  module Aspect
-
-    module Pagination
-
-      def offset n = 0
-      end
-
-      def limit n = 1
-      end
-
-      def next limit = 0
-      end
-    end
-  end
-end

data/lib/commute/aspects/url.rb

@@ -1,57 +0,0 @@
-module Commute
-  module Aspect
-
-    module Url
-
-      def self.included base
-        base.extend ClassMethods
-      end
-
-      module ClassMethods
-        def url pattern
-          transform &generate(pattern)
-        end
-
-        private
-
-        def generate pattern
-          # Regex to match different parts of a URL.
-          matcher = \
-            /(?<scheme>https?):\/\/(?<host>[^\/:]+):?(?<port>\d+)?(?<path>[^\.]*)(?<extension>\..+)?/
-          # Match the pattern.
-          matched = matcher.match(pattern)
-          raise 'Invalid url: At least a host and scheme required' \
-            unless matched && matched[:host] && matched[:scheme]
-          # Collect the parts.
-          parts = {
-            scheme: matched[:scheme],
-            host: matched[:host].split('.'),
-            port: matched[:port],
-            path: matched[:path].split('/'),
-            extension: matched[:extension]
-          }
-
-          Proc.new do |request, context|
-            request.scheme = parts[:scheme]
-            request.host = fill(parts[:host], context).join '.'
-            request.path = fill(parts[:path], context).join('/') + (parts[:extension] || '')
-            request.port = matched[:port]
-          end
-        end
-
-        def fill parts, params
-          new_parts = []
-          parts.each do |part|
-            if part.start_with?('$')
-              param = params[part[1..-1].to_sym]
-              new_parts << param if param
-            else
-              new_parts << part
-            end
-          end
-          new_parts
-        end
-      end
-    end
-  end
-end

data/lib/commute/common/cache.rb

@@ -1,43 +0,0 @@
-module Commute
-  module Common
-
-    module Cache
-
-      class Success
-
-        def success?
-          true
-        end
-      end
-
-      SUCCESS = Success.new
-
-      class Fetch
-        @id = :cache
-
-        def call commuter, cache = nil
-          return unless cache
-          request = commuter.get
-          # Hit.
-          if request.method == :get && result = cache.get(request.url)
-            commuter.set [result, SUCCESS]
-            commuter.tag :hit
-            commuter.return
-          end
-        end
-      end
-
-      class Store
-        @id = :cache
-
-        def call commuter, cache = nil
-          return unless cache
-          response = commuter.get
-          if response.request.method == :get && response.body
-            cache.set response.request.url, response.body
-          end
-        end
-      end
-    end
-  end
-end

data/lib/commute/common/conditional.rb

@@ -1,27 +0,0 @@
-require 'commute/core/commuter'
-
-module Commute
-  module Common
-    module Conditional
-
-      class Tagged
-
-        def initialize processor, *tags
-          @processor = processor
-          @tags = tags
-        end
-
-        def call commuter
-          @processor.call unless @tags.any? { |tag| commuter.tagged? tag }
-        end
-      end
-
-      class NotTagged < Tagged
-
-        def call commuter
-          @processor.call commuter if @tags.all? { |tag| !commuter.tagged? tag }
-        end
-      end
-    end
-  end
-end