aitch 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c38a1b4c89a137aad0faec66bd2c53f00d59871c
+  data.tar.gz: 6d6054265f125130692693f502f43e856830a7e8
+SHA512:
+  metadata.gz: 233cb27de492f6e8f03cceaf0f8d5ddf65aaffdaee7aaf963db1865aecbed347024360727ec5e72e3064bd046b53bc196e7f50cdce435a5cc6ae8bd38d3ca62b
+  data.tar.gz: 9c02590e9d20323273e4584ae86f0ac0694ef316a2e35be6e2c7516402afb78991110f9aa228cbd2a35207c3c8dd510df57da2e4d6720906b55286401a7a2e26

data/README.md

@@ -1,9 +1,7 @@
 # Aitch
 
 [![Build Status](https://travis-ci.org/fnando/aitch.png)](https://travis-ci.org/fnando/aitch)
-
 [![CodeClimate](https://codeclimate.com/github/fnando/aitch.png)](https://codeclimate.com/github/fnando/aitch/)
-
 [![RubyGems](https://badge.fury.io/rb/aitch.png)](https://rubygems.org/gems/aitch)
 
 A simple HTTP client.
@@ -132,6 +130,20 @@ Aitch.get("http://restrict.example.org/", {}, {}, user: "john", password: "test"
 Aitch.get("http://example.org", {}, {"User-Agent" => "MyBot/1.0.0"})
 ```
 
+### Creating namespaced requests
+
+Sometimes you don't want to use the global settings (maybe you're building a
+lib). In this case, you can instantiate the namespace.
+
+```ruby
+Request = Aitch::Namespace.new
+Request.configure do |config|
+  config.user_agent = "MyLib/1.0.0"
+end
+
+Request.get("http://example.org")
+```
+
 ## Contributing
 
 1. Fork it

data/lib/aitch.rb

@@ -3,6 +3,7 @@ require "forwardable"
 require "json"
 require "zlib"
 
+require "aitch/namespace"
 require "aitch/configuration"
 require "aitch/errors"
 require "aitch/request"
@@ -14,34 +15,25 @@ require "aitch/xml_parser"
 require "aitch/version"
 
 module Aitch
-  extend self
+  class << self
+    extend Forwardable
 
-  def execute(method, url, args = {}, headers = {}, options = {})
-    Request.new(method, url, args, headers, options).perform
+    def_delegators :namespace,
+      :configuration, :config,
+      :get, :get!,
+      :post, :post!,
+      :put, :put!,
+      :patch, :patch!,
+      :options, :options!,
+      :trace, :trace!,
+      :head, :head!,
+      :delete, :delete!,
+      :execute, :execute!,
+      :configure
   end
 
-  def execute!(*args)
-    response = execute(*args)
-    raise response.error if response.error?
-    response
-  end
-
-  %w[
-    get
-    post
-    put
-    patch
-    delete
-    options
-    trace
-    head
-  ].each do |method_name|
-    define_method(method_name) do |url, args = {}, headers = {}, options = {}|
-      execute(method_name, url, args, headers, options)
-    end
-
-    define_method("#{method_name}!") do |url, args = {}, headers = {}, options = {}|
-      execute!(method_name, url, args, headers, options)
-    end
+  private
+  def self.namespace
+    @namespace ||= Namespace.new
   end
 end

data/lib/aitch/configuration.rb

@@ -37,12 +37,4 @@ module Aitch
       @xml_parser = XMLParser
     end
   end
-
-  def self.configure(&block)
-    yield configuration
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
 end

data/lib/aitch/namespace.rb

@@ -0,0 +1,48 @@
+module Aitch
+  class Namespace
+    def configure(&block)
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+    alias_method :configuration, :config
+
+    def execute(request_method, url, data = {}, headers = {}, options = {})
+      Request.new({
+        config: config,
+        request_method: request_method,
+        url: url,
+        data: data,
+        headers: headers,
+        options: options
+      }).perform
+    end
+
+    def execute!(*args)
+      response = execute(*args)
+      raise response.error if response.error?
+      response
+    end
+
+    %w[
+      get
+      post
+      put
+      patch
+      delete
+      options
+      trace
+      head
+    ].each do |method_name|
+      define_method(method_name) do |url, data = {}, headers = {}, options = {}|
+        execute(method_name, url, data, headers, options)
+      end
+
+      define_method("#{method_name}!") do |url, data = {}, headers = {}, options = {}|
+        execute!(method_name, url, data, headers, options)
+      end
+    end
+  end
+end

data/lib/aitch/redirect.rb

@@ -1,8 +1,9 @@
 module Aitch
   class Redirect
-    def initialize
+    def initialize(config)
       @tries = 1
-      @max_tries = Aitch.configuration.redirect_limit
+      @config = config
+      @max_tries = @config.redirect_limit
     end
 
     def followed!
@@ -14,7 +15,7 @@ module Aitch
     end
 
     def enabled?
-      Aitch.configuration.follow_redirect
+      @config.follow_redirect
     end
   end
 end

data/lib/aitch/request.rb

@@ -1,16 +1,24 @@
 module Aitch
   class Request
-    def initialize(request_method, url, args = {}, headers = {}, options = {})
-      @request_method = request_method
-      @url = url
-      @args = args
-      @headers = headers
-      @options = options
+    attr_accessor :config
+    attr_accessor :request_method
+    attr_accessor :url
+    attr_accessor :data
+    attr_accessor :headers
+    attr_accessor :options
+
+    def initialize(options)
+      options.each do |name, value|
+        public_send("#{name}=", value)
+      end
+
+      self.headers ||= {}
+      self.options ||= {}
     end
 
     def perform
-      response = Response.new(client.request(request))
-      redirect = Redirect.new
+      response = Response.new(config, client.request(request))
+      redirect = Redirect.new(config)
 
       while redirect.follow?(response)
         redirect.followed!
@@ -43,37 +51,37 @@ module Aitch
     end
 
     def uri
-      @uri ||= URI.parse(@url)
+      @uri ||= URI.parse(url)
     rescue URI::InvalidURIError
       raise InvalidURIError
     end
 
     def http_method_class
-      Net::HTTP.const_get(@request_method.to_s.capitalize)
+      Net::HTTP.const_get(request_method.to_s.capitalize)
     rescue NameError
-      raise InvalidHTTPMethodError, "unexpected HTTP verb: #{@request_method.inspect}"
+      raise InvalidHTTPMethodError, "unexpected HTTP verb: #{request_method.inspect}"
     end
 
     private
     def set_body(request)
-      if @args.respond_to?(:to_h)
-        request.form_data = @args.to_h
-      elsif @args.kind_of?(Hash)
-        request.form_data = @args
+      if data.respond_to?(:to_h)
+        request.form_data = data.to_h
+      elsif data.kind_of?(Hash)
+        request.form_data = data
       else
-        request.body = @args.to_s
+        request.body = data.to_s
       end
     end
 
     def set_headers(request)
-      all_headers = Aitch.configuration.default_headers.merge(@headers)
+      all_headers = config.default_headers.merge(headers)
       all_headers.each do |name, value|
         request[name.to_s] = value.to_s
       end
     end
 
     def set_credentials(request)
-      request.basic_auth(@options[:user], @options[:password]) if @options[:user]
+      request.basic_auth(options[:user], options[:password]) if options[:user]
     end
 
     def set_https(client)
@@ -82,16 +90,16 @@ module Aitch
     end
 
     def set_timeout(client)
-      client.read_timeout = Aitch.configuration.timeout
+      client.read_timeout = config.timeout
     end
 
     def set_logger(client)
-      logger = Aitch.configuration.logger
+      logger = config.logger
       client.set_debug_output(logger) if logger
     end
 
     def set_user_agent(request)
-      request["User-Agent"] = Aitch.configuration.user_agent
+      request["User-Agent"] = config.user_agent
     end
 
     def set_gzip(request)

data/lib/aitch/response.rb

@@ -4,7 +4,8 @@ module Aitch
 
     def_delegators :@http_response, :content_type
 
-    def initialize(http_response)
+    def initialize(config, http_response)
+      @config = config
       @http_response = http_response
     end
 
@@ -46,9 +47,9 @@ module Aitch
 
     def data
       if json?
-        Aitch.configuration.json_parser.load(body)
+        @config.json_parser.load(body)
       elsif xml?
-        Aitch.configuration.xml_parser.load(body)
+        @config.xml_parser.load(body)
       else
         body
       end

data/lib/aitch/version.rb

@@ -1,3 +1,3 @@
 module Aitch
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/aitch/aitch_spec.rb

@@ -20,25 +20,36 @@ describe Aitch do
     it { should respond_to(:trace!) }
     it { should respond_to(:execute) }
     it { should respond_to(:execute!) }
+    it { should respond_to(:config) }
+    it { should respond_to(:configuration) }
   end
 
   describe "#execute" do
     let(:request) { mock.as_null_object }
 
     it "delegates to Request" do
+      expected = {
+        config: Aitch.config,
+        request_method: "get",
+        url: "URL",
+        data: "DATA",
+        headers: "HEADERS",
+        options: "OPTIONS"
+      }
+
       Aitch::Request
         .should_receive(:new)
-        .with("METHOD", "URL", "ARGS", "HEADERS", "OPTIONS")
+        .with(expected)
         .and_return(request)
 
-      Aitch.execute("METHOD", "URL", "ARGS", "HEADERS", "OPTIONS")
+      Aitch.get("URL", "DATA", "HEADERS", "OPTIONS")
     end
 
     it "performs request" do
       Aitch::Request.stub new: request
       request.should_receive(:perform)
 
-      Aitch.execute("METHOD", "URL")
+      Aitch.get("URL")
     end
   end
 
@@ -47,7 +58,7 @@ describe Aitch do
       response = stub(error?: false)
       Aitch::Request.any_instance.stub perform: response
 
-      expect(Aitch.execute!("METHOD", "URL")).to eql(response)
+      expect(Aitch.get!("URL")).to eql(response)
     end
 
     it "raises when has errors" do
@@ -55,7 +66,7 @@ describe Aitch do
       Aitch::Request.any_instance.stub perform: response
 
       expect {
-        Aitch.execute!("METHOD", "URL")
+        Aitch.get!("URL")
       }.to raise_error("ERROR")
     end
   end

data/spec/aitch/namespace_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Aitch::Namespace do
+  it "isolates namespace configuration" do
+    ns = Aitch::Namespace.new
+    ns.config.user_agent = "MyLib/1.0.0"
+
+    expect(ns.config.user_agent).to eql("MyLib/1.0.0")
+    expect(Aitch.config.user_agent).to match(%r[^Aitch])
+  end
+end

data/spec/aitch/request_spec.rb

@@ -1,14 +1,22 @@
 require "spec_helper"
 
 describe Aitch::Request do
+  def build_request(options = {})
+    Aitch::Request.new({
+      request_method: "get",
+      url: "URL",
+      config: Aitch::Configuration.new
+    }.merge(options))
+  end
+
   it "raises with invalid uri" do
     expect {
-      Aitch::Request.new("post", "\\").uri
+      build_request(url: "\\").uri
     }.to raise_error(Aitch::InvalidURIError)
   end
 
   it "raises on timeout", ruby: 2.0 do
-    request = Aitch::Request.new("post", "http://example.org")
+    request = build_request(request_method: "post", url: "http://example.org")
     request.stub_chain(:client, :request).and_raise(Net::ReadTimeout)
 
     expect {
@@ -17,7 +25,7 @@ describe Aitch::Request do
   end
 
   it "raises on timeout", ruby: 1.9 do
-    request = Aitch::Request.new("post", "http://example.org")
+    request = build_request(request_method: "post", url: "http://example.org")
     request.stub_chain(:client, :request).and_raise(Timeout::Error)
 
     expect {
@@ -26,56 +34,59 @@ describe Aitch::Request do
   end
 
   it "sets user agent" do
-    request = Aitch::Request.new("post", "http://example.org/some/path").request
-    expect(request["User-Agent"]).to eql(Aitch.configuration.user_agent)
+    requester = build_request
+    request = requester.request
+    expect(request["User-Agent"]).to eql(requester.config.user_agent)
   end
 
   it "requests gzip encoding" do
-    request = Aitch::Request.new("get", "http://example.org").request
+    request = build_request.request
     expect(request["Accept-Encoding"]).to eql("gzip,deflate")
   end
 
   it "sets path" do
-    request = Aitch::Request.new("post", "http://example.org/some/path").request
+    request = build_request(url: "http://example.org/some/path").request
     expect(request.path).to eql("/some/path")
   end
 
   it "sets request body from hash" do
-    request = Aitch::Request.new("post", "http://example.org/", {a: 1}).request
+    request = build_request(data: {a: 1}).request
     expect(request.body).to eql("a=1")
   end
 
   it "sets request body from string" do
-    request = Aitch::Request.new("post", "http://example.org/", "some body").request
+    request = build_request(data: "some body").request
     expect(request.body).to eql("some body")
   end
 
   it "sets request body from to_h protocol" do
     data = stub(to_h: {a: 1})
-    request = Aitch::Request.new("post", "http://example.org/", data).request
+    request = build_request(data: data).request
     expect(request.body).to eql("a=1")
   end
 
   it "sets request body from to_s protocol" do
     data = stub(to_s: "some body")
-    request = Aitch::Request.new("post", "http://example.org/", data).request
+    request = build_request(data: data).request
 
     expect(request.body).to eql("some body")
   end
 
   it "sets default headers" do
-    Aitch.configuration.default_headers = {"HEADER" => "VALUE"}
-    request = Aitch::Request.new("post", "http://example.org/").request
+    requester = build_request
+    requester.config.default_headers = {"HEADER" => "VALUE"}
+    request = requester.request
+
     expect(request["HEADER"]).to eql("VALUE")
   end
 
   it "sets custom headers" do
-    request = Aitch::Request.new("post", "http://example.org/", {}, {"HEADER" => "VALUE"}).request
+    request = build_request(headers: {"HEADER" => "VALUE"}).request
     expect(request["HEADER"]).to eql("VALUE")
   end
 
   it "sets basic auth credentials" do
-    request = Aitch::Request.new("post", "http://example.org/", {}, {}, {user: "USER", password: "PASS"}).request
+    request = build_request(options: {user: "USER", password: "PASS"}).request
     credentials = Base64.decode64(request["Authorization"].gsub(/Basic /, ""))
 
     expect(credentials).to eql("USER:PASS")
@@ -83,9 +94,8 @@ describe Aitch::Request do
 
   describe "#client" do
     context "https" do
-      subject(:client) {
-        Aitch::Request.new("get", "https://example.org").client
-      }
+      let(:request) { build_request(url: "https://example.org") }
+      subject(:client) { request.client }
 
       it "sets https" do
         expect(client.use_ssl?).to be_true
@@ -96,7 +106,7 @@ describe Aitch::Request do
       end
 
       it "sets timeout" do
-        Aitch.configuration.timeout = 20
+        request.config.timeout = 20
         expect(client.read_timeout).to eql(20)
       end
     end
@@ -105,7 +115,7 @@ describe Aitch::Request do
   describe "Request class" do
     it "raises with invalid method" do
       expect {
-        Aitch::Request.new("invalid", "URL").request
+        build_request(request_method: "invalid").request
       }.to raise_error(Aitch::InvalidHTTPMethodError, %[unexpected HTTP verb: "invalid"])
     end
 
@@ -120,7 +130,7 @@ describe Aitch::Request do
       trace
     ].each do |method|
       it "instantiates #{method.upcase} method" do
-        request = Aitch::Request.new(method, "URL").request
+        request = build_request(request_method: method).request
         expect(request.class.name).to eql("Net::HTTP::#{method.capitalize}")
       end
     end

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: aitch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-04-30 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: '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: rspec
   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: pry-meta
   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: test_notifier
   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: fakeweb
   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: nokogiri
   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'
 description: A simple HTTP client
@@ -141,6 +126,7 @@ files:
 - lib/aitch.rb
 - lib/aitch/configuration.rb
 - lib/aitch/errors.rb
+- lib/aitch/namespace.rb
 - lib/aitch/redirect.rb
 - lib/aitch/request.rb
 - lib/aitch/response.rb
@@ -150,6 +136,7 @@ files:
 - lib/aitch/xml_parser.rb
 - spec/aitch/aitch_spec.rb
 - spec/aitch/configuration_spec.rb
+- spec/aitch/namespace_spec.rb
 - spec/aitch/request_spec.rb
 - spec/aitch/response_spec.rb
 - spec/aitch/xml_parser_spec.rb
@@ -157,31 +144,31 @@ files:
 homepage: http://rubygems.org/gems/aitch
 licenses:
 - MIT
+metadata: {}
 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: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple HTTP client
 test_files:
 - spec/aitch/aitch_spec.rb
 - spec/aitch/configuration_spec.rb
+- spec/aitch/namespace_spec.rb
 - spec/aitch/request_spec.rb
 - spec/aitch/response_spec.rb
 - spec/aitch/xml_parser_spec.rb