someapi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f026e9cad3240ec1c275409e82272d601ca13230
-  data.tar.gz: e73c051d5f2eba1c9f10e90cc948365be6d9c05b
+  metadata.gz: 789f481193c3ec05d0199300a2ccf08fe882fd34
+  data.tar.gz: 43bcf8ffc6ae3ce950023f8d2efcd1341020fec4
 SHA512:
-  metadata.gz: c64f30f3523c35d6604c939553a321faab0fc8b05f45c00ddd7fea0d8201a01c263a48186bc54dfec9f9d561c177e9ec22513bb47f030b2b96b7c5ee99b9854b
-  data.tar.gz: f97a01af2f90419dbe770d16e0e14c2ed75309e4717cc0d1751007e93d68111fbb35cb81b3c7494dd26f0fc14f928a206940b7113b6070a32c79a0c377fdf7c2
+  metadata.gz: cf2e8df6edf80e54a8d2d4bcc90661d2600a991ca9ec2fd917aaedd3b0ecfc42a076927edf90a6e70a048d83ed78b16cf75a01fd6573faf849c246e974a3c9ca
+  data.tar.gz: 1cd1cfe77ce345c08edb8a7c8317be9a8adad1da9fe73211909d61996c171ae4540fae50a1de8a42f19e0c70d1f02c22b24437f8901d3d2bb7a399a34333ace9

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - "2.1.2"
+  - "2.0.0"
+  - "1.9.3"
+script: bundle exec rspec spec

data/README.md

@@ -1,8 +1,10 @@
 # SomeAPI
+[![Build Status](https://travis-ci.org/jellymann/someapi.svg?branch=master)](https://travis-ci.org/jellymann/someapi)
+[![Code Climate](https://codeclimate.com/github/jellymann/someapi.png)](https://codeclimate.com/github/jellymann/someapi)
 
 Built around HTTParty, SomeAPI provides a generic wrapper for your favourite RESTful WebAPI. Simply extend Some::API and apply your usual HTTParty options like base_uri, then call your new API and party harder!
 
-## Installation
+## Get Some
 
 Add this line to your application's Gemfile:
 
@@ -48,6 +50,10 @@ Don't stub your toe on external services!
 
         Some::API.include WebMock::API
 
+     NOTE: If you're using Ruby version before 2.1.x, then you'll have to include WebMock like this:
+
+        Some::API.send :include, WebMock::API
+
   3. Adding `stub` before the HTTP method in a SomeAPI request will instead return a Webmock stub after the bang.
 
         github = Github.new
@@ -59,13 +65,13 @@ Stubs look exactly the same as their corresponding requests except for the prese
 
 ## Tips and Gotchas
 
-If your request ends in a `[someth]` remember to put a dot before the bang, as in the examples. Ruby doesn't define the (very odd and mostly useless actually) operator for `[]!`.
+If your request ends in a `[whatever]` remember to put a dot before the bang, as in the examples. Ruby doesn't define the (very odd and mostly useless actually) operator for `[]!`.
 
 Posting hashes can be done more succinctly by using the `<<` operator, as follows (using the post example from above):
 
     github.post.repos[@username][@repo].pulls << { title: "Foo", body: "Pull my Foo", ... }
 
-Also note that every time you do this (put the bang at the beginning of a request):
+CAUTION: Every time you do the following (ie. put the bang at the beginning of a request):
 
     !github.get.users[@some_user]
 

data/lib/someapi.rb

@@ -9,23 +9,26 @@ module Some
 
     API_REGEX = /^[a-zA-Z0-9_]+[!]?$/
 
-    def initialize options={}, meth=nil, path=nil, stubbed=false
-      @meth = meth
-      @path = path
-      @options = options
+    def initialize options={}
+      @method = options[:method]
+      @path = options[:path]
 
       # stubbed is a flag set when you're stubbing the API call
       # used in testing
       # just call 'stub' in the call chain before the http_method method
-      @stubbed = stubbed
+      @stubbed = options[:stubbed]
+
+      @options = options.delete_if do |k|
+        [:method, :path, :stubbed].include? k
+      end
     end
 
     # http_method methods
     # used in the call chain to set the http method
     %W(get post put patch delete copy move head options).each do |meth|
       define_method(meth) do
-        unless @meth
-          self.class.new Hash.new, meth.to_s, nil, @stubbed
+        unless @method
+          make_new method: meth.to_s, stubbed: @stubbed
         else
           self[meth]
         end
@@ -35,8 +38,8 @@ module Some
     # use in the call chain to flag this request as a stub
     # used in testing for setting up API-call stubs
     def stub
-      unless @meth
-        self.class.new Hash.new, @meth, @path, true
+      unless @method
+        make_new method: @method, path: @path, stubbed: true
       else
         self['stub']
       end
@@ -57,77 +60,69 @@ module Some
     # 'calls' the API request
     # (or makes the stub, if stubbed)
     def ! options = {}
+      merged_options = merge_headers_and_queries options
       unless @stubbed
-        self.class.send(@meth, @path || '/', deep_merge(options,@options))
+        self.class.send(@method, @path || '/', merged_options)
       else
         uri = "#{self.class.base_uri}#{@path}"
 
-        deep_merge(options,@options)
-        process_headers(options)
-        process_query(options)
-        options = self.class.default_options.
-          merge(@options.merge(options))
-
-        stub_request(@meth.to_sym, uri.to_s).with(options)
+        stub_request(@method.to_sym, uri.to_s).with merged_options
       end
     end
 
     # chains 'thing' onto URL path
     def [] thing
-      self.class.new @options, @meth, "#{@path || ''}/#{thing}", @stubbed
+      make_new method: @method,
+               path: "#{@path || ''}/#{thing}",
+               stubbed: @stubbed
     end
 
     # this is where the fun begins...
     def method_missing meth, *args, &block
-      meths = meth.to_s
-      if @meth && meths =~ API_REGEX
+      meth_s = meth.to_s
+      if @method && meth_s =~ API_REGEX
 
-        if meths.end_with?('!')
+        if meth_s.end_with?('!')
           # `foo! bar' is syntactic sugar for `foo.! bar'
-          self[meths[0...-1]].!(args[0] || {})
+          self[meth_s[0...-1]].!(args[0] || {})
 
         else
           # chain the method name onto URL path
-          self[meths]
+          self[meth_s]
         end
       else
         super
       end
     end
 
-    def respond_to_missing? meth
-      @meth && meth.to_s =~ API_REGEX
+    def respond_to_missing? method
+      @method && method.to_s =~ API_REGEX
     end
 
     private
 
-      # shamelessly stolen from HTTParty
-      def process_headers(options)
-        if options[:headers] && self.class.headers.any?
-          options[:headers] = self.class.headers.merge(options[:headers])
-        end
+      def merge_headers_and_queries options
+        merge_headers merge_queries options
       end
 
-      # shamelessly copied from above, but for :query
-      def process_query(options)
-        if self.class.default_options[:default_params]
-          options[:query] = self.class.default_options[:default_params].
-            merge(options[:query] || {})
-        end
+      def merge_headers options
+        options.merge({
+          headers: (self.class.headers || {}).
+            merge((@options[:headers] || {}).
+            merge(options[:headers] || {}))
+        })
       end
 
-      # merge a hash within a hash from two hashes (yo-dawg...)
-      def merge_stuff(a,b,tag)
-        if a[tag] && b[tag]
-          a[tag] = b[tag].merge(a[tag])
-        end
+      def merge_queries options
+        options.merge({
+          query: (self.class.default_options[:default_params] || {}).
+            merge((@options[:query] || {}).
+            merge(options[:query]|| {}))
+        })
       end
 
-      # just merge_stuff like :headers and :query... you know, HTTP stuff
-      def deep_merge(a,b)
-        merge_stuff(a,b,:headers)
-        merge_stuff(a,b,:query)
-        b.merge(a)
+      def make_new opts={}
+        self.class.new @options.merge(opts)
       end
 
   end

data/lib/someapi/version.rb

@@ -1,3 +1,3 @@
 module Some
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/someapi.gemspec

@@ -18,8 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "httparty", "~> 0.13.1"
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_runtime_dependency "httparty", "~> 0.13"
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", '~> 3.0'
+  spec.add_development_dependency "webmock", '~> 1.18'
 end

data/spec/someapi_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Some::API do
+
+  let(:moar_headers) { { 'X-Fizz' => 'Buzz' } }
+  let(:moar_params) { { 'fizz' => 'buzz' } }
+  let(:all_the_headers) { test_headers.merge(moar_headers) }
+  let(:all_the_params) { test_params.merge(moar_params) }
+  let(:test_body) { { 'baz' => 'qux' } }
+
+  let(:even_moar_headers) { { 'X-Baz' => 'Qux' } }
+  let(:even_moar_params) { { 'baz' => 'qux' } }
+
+  let(:api) { TestAPI.new query: moar_params,
+                          headers: moar_headers }
+
+  it 'requests endpoints using method_missing' do
+    stub = stub_request(:get, "http://example.com/foo/bar?fizz=buzz&foo=bar").
+      with(:headers => all_the_headers)
+
+    api.get.foo.bar!
+    api.get.foo.bar.!
+
+    expect(stub).to have_been_requested.times(2)
+  end
+
+  it 'requests endpoints using subscript operator' do
+    stub = stub_request(:get, "http://example.com/foo/bar?fizz=buzz&foo=bar").
+      with(:headers => all_the_headers)
+
+    api.get['foo']['bar'].!
+
+    expect(stub).to have_been_requested
+  end
+
+
+  it 'requests endpoints with query' do
+    stub = stub_request(:get, "http://example.com/foo/bar?baz=qux&fizz=buzz&foo=bar").
+      with(:headers => all_the_headers)
+
+    api.get.foo.bar! query: even_moar_params
+
+    expect(stub).to have_been_requested
+  end
+
+  it 'requests endpoints with headers' do
+    stub = stub_request(:get, "http://example.com/foo/bar?fizz=buzz&foo=bar").
+      with(:headers => all_the_headers.merge(even_moar_headers))
+
+    api.get.foo.bar! headers: even_moar_headers
+
+    expect(stub).to have_been_requested
+  end
+
+  it 'requests endpoints with body' do
+    stub = stub_request(:post, "http://example.com/foo/bar?fizz=buzz&foo=bar").
+      with(:headers => all_the_headers, :body => test_body)
+
+    api.post.foo.bar! body: test_body
+
+    expect(stub).to have_been_requested
+  end
+end

data/spec/someapi_stub_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+Some::API.send :include, WebMock::API
+
+describe 'Some::API stubs' do
+
+  let(:moar_headers) { { 'X-Fizz' => 'Buzz' } }
+  let(:moar_params) { { 'fizz' => 'buzz' } }
+  let(:all_the_headers) { test_headers.merge moar_headers }
+  let(:all_the_params) { test_params.merge moar_params }
+  let(:test_body) { { 'baz' => 'qux' } }
+
+  let(:even_moar_headers) { { 'X-Baz' => 'Qux' } }
+  let(:even_moar_params) { { 'baz' => 'qux' } }
+
+  let(:api) { TestAPI.new query: moar_params,
+                          headers: moar_headers }
+
+  it 'stubs endpoints using method_missing' do
+    stub = api.stub.get.foo.bar!
+    stub2 = api.stub.get.foo.bar.!
+
+    HTTParty.get('http://example.com/foo/bar?fizz=buzz&foo=bar',
+                headers: all_the_headers)
+
+    expect(stub).to have_been_requested
+    expect(stub2).to have_been_requested
+  end
+
+  it 'stubs endpoints using subscript operator' do
+    stub = api.stub.get['foo']['bar'].!
+
+    HTTParty.get('http://example.com/foo/bar?fizz=buzz&foo=bar',
+                 headers: all_the_headers)
+
+    expect(stub).to have_been_requested
+  end
+
+  it 'stubs endpoints with query' do
+    stub = api.stub.get.foo.bar! query: even_moar_params
+
+    HTTParty.get('http://example.com/foo/bar?baz=qux&fizz=buzz&foo=bar',
+                headers: all_the_headers)
+
+    expect(stub).to have_been_requested
+  end
+
+  it 'stubs endpoints with headers' do
+    stub = api.stub.get.foo.bar! headers: even_moar_headers
+
+    HTTParty.get('http://example.com/foo/bar?fizz=buzz&foo=bar',
+                 headers: all_the_headers.merge(even_moar_headers))
+
+    expect(stub).to have_been_requested
+  end
+
+  it 'stubs endpoints with body' do
+    stub = api.stub.post.foo.bar! body: test_body
+
+    HTTParty.post('http://example.com/foo/bar?fizz=buzz&foo=bar',
+                 headers: all_the_headers,
+                 body: test_body)
+
+    expect(stub).to have_been_requested
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,66 @@
+require 'someapi'
+require 'webmock/rspec'
+require 'httparty'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  #config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/test_api.rb

@@ -0,0 +1,13 @@
+def test_headers
+  { 'X-Hello' => 'World' }
+end
+
+def test_params
+  { 'foo' => 'bar' }
+end
+
+class TestAPI < Some::API
+  base_uri 'http://example.com/'
+  headers test_headers
+  default_params test_params
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: someapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
 description: Built around HTTParty, SomeAPI provides a generic wrapper for your favourite
   RESTful WebAPI. Simply extend Some::API and apply your usual HTTParty options like
   base_uri, then call your new API and party harder!
@@ -62,6 +90,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,6 +100,10 @@ files:
 - lib/someapi.rb
 - lib/someapi/version.rb
 - someapi.gemspec
+- spec/someapi_spec.rb
+- spec/someapi_stub_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_api.rb
 homepage: https://github.com/jellymann/someapi
 licenses:
 - MIT
@@ -81,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -93,4 +128,8 @@ rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: A generic RESTful API wrapper.
-test_files: []
+test_files:
+- spec/someapi_spec.rb
+- spec/someapi_stub_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_api.rb