nationbuilder-rb 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf96a097d7dc9537d878eb7126432734976413ab
-  data.tar.gz: fe1ea5df69c91cfac7413fb5d79c2335aaec8394
+  metadata.gz: c5dbf155a35ce3dc4e6e6a589a2e21ee3cc72c8a
+  data.tar.gz: fa021eae289bd54ce766f9830c8209d9945fbf86
 SHA512:
-  metadata.gz: 11fc1a4ea5b90e1975064f71d10ecbf0b5ca97bac3a49fe18a08bdfac1e3e403d834efaf105e4af775d457e9cc35dd5fc05a908a7684b15ab1e7b2543c264a77
-  data.tar.gz: 250a305f388d469a4186005a5aec3e5a602598cedb8831a53264fef7401f2a4f7e183598e633b16bddf6429c4415d0ba8f12ceed1b2c79294458804c68693484
+  metadata.gz: 2c52251b51f1f8e525d18bfd7bf3875a480a525a32176441c6770bbe300ac5e532aa5d84aecb0cdacb2dde1f6aca278482f74a99c797b8877183e985e9d7f7df
+  data.tar.gz: 5391541f46bc04bad1e0e7eab1332094b52c917f3d2b7c4d30a4bca22aca0591b8c770e9266c52fa03e3445e92e9c2c48a7165a9ccb3189ec292dcb9a4e0de33

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1.0
   - 2.2.5
   - 2.3.1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.5.0
+- [#31] Allow for a user provided HTTPClient 
+
 # 1.4.3
 - [#34] Fix `Content-Type` header check
 

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gem 'httpclient', '~> 2.7'
 
 group :development do
-  gem 'jeweler', '~> 2.0'
+  gem 'rake', '~> 10.4'
   gem 'rspec', '~> 3.2'
   gem 'simplecov', '~> 0.8'
   gem 'vcr', '~> 2.9'

data/Gemfile.lock

@@ -2,54 +2,13 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.7)
-    builder (3.2.2)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    faraday (0.9.1)
-      multipart-post (>= 1.2, < 3)
-    git (1.2.9.1)
-    github_api (0.12.3)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.3)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.3)
-      oauth2
-    hashie (3.4.0)
-    highline (1.6.21)
     httpclient (2.7.0.1)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-    json (1.8.2)
-    jwt (1.2.1)
-    mini_portile2 (2.0.0)
     multi_json (1.10.1)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.6.4)
-    rake (10.4.2)
-    rdoc (4.2.0)
-      json (~> 1.4)
+    rake (10.5.0)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -69,7 +28,6 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    thread_safe (0.3.4)
     vcr (2.9.3)
     webmock (1.20.4)
       addressable (>= 2.3.6)
@@ -80,11 +38,11 @@ PLATFORMS
 
 DEPENDENCIES
   httpclient (~> 2.7)
-  jeweler (~> 2.0)
+  rake (~> 10.4)
   rspec (~> 3.2)
   simplecov (~> 0.8)
   vcr (~> 2.9)
   webmock (~> 1.18)
 
 BUNDLED WITH
-   1.11.2
+   1.13.6

data/README.md

@@ -123,6 +123,15 @@ Endpoint: basic_pages
 ...
 ```
 
+## Modifying the underlying HTTPClient
+
+The `NationBuilder::Client` object can use a provided [HTTPClient](http://www.rubydoc.info/gems/httpclient/frames) object if you need some customizations, such as to enable logging, change TLS settings, or add a proxy. For example to force a proxy for all traffic:
+
+```Ruby
+httpclient = HTTPClient.new('http://myproxy:8080')
+client = NationBuilder::Client.new(nation_builder_slug, nation_builder_auth_token, retries: 8, http_client: httpclient)
+```
+
 ## Development
 
 To update the API specification that powers this client, first make

data/Rakefile

@@ -1,19 +1,5 @@
 require 'rubygems'
 require 'rake'
-require 'jeweler'
-
-Jeweler::Tasks.new do |gem|
-  gem.name = 'nationbuilder-rb'
-  gem.homepage = 'http://github.com/nationbuilder/nationbuilder-rb'
-  gem.license = 'MIT'
-  gem.summary = 'A Ruby client to the NationBuilder API'
-  gem.description = 'A Ruby client to the NationBuilder API'
-  gem.email = 'schmitt@nationbuilder.com'
-  gem.authors = ['David Huie', 'Alexandre Schmitt']
-end
-
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 

data/lib/nationbuilder.rb

@@ -6,6 +6,7 @@ require 'uri'
 
 module NationBuilder; end
 
+require 'nationbuilder/version'
 require 'nationbuilder/client'
 require 'nationbuilder/endpoint'
 require 'nationbuilder/method'

data/lib/nationbuilder/client.rb

@@ -6,6 +6,7 @@ class NationBuilder::Client
     @name_to_endpoint = {}
     @base_url = opts[:base_url] || 'https://:nation_name.nationbuilder.com'
     @retries = opts[:retries] || 8
+    @http_client = opts[:http_client] || HTTPClient.new
 
     if @retries < 0
       raise 'Retries must be at least zero'
@@ -81,7 +82,7 @@ class NationBuilder::Client
 
     (@retries + 1).times do |i|
       begin
-        raw_response = HTTPClient.send(method, url, request_args)
+        raw_response = @http_client.send(method, url, request_args)
         parsed_response = parse_response_body(raw_response)
       rescue NationBuilder::RateLimitedError => e
         exception_to_reraise = e

data/lib/nationbuilder/version.rb

@@ -0,0 +1,5 @@
+module NationBuilder
+
+  VERSION = '1.5.0'.freeze
+
+end

data/nationbuilder-rb.gemspec

@@ -1,17 +1,13 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: nationbuilder-rb 1.4.2 ruby lib
+require './lib/nationbuilder/version'
 
 Gem::Specification.new do |s|
   s.name = "nationbuilder-rb"
-  s.version = "1.4.3"
+  s.version = NationBuilder::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["David Huie", "Alexandre Schmitt"]
-  s.date = "2016-11-28"
+  s.date = "2016-12-06"
   s.description = "A Ruby client to the NationBuilder API"
   s.email = "schmitt@nationbuilder.com"
   s.executables = ["nbdoc"]
@@ -31,7 +27,6 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md",
     "Rakefile",
-    "VERSION",
     "bin/nbdoc",
     "lib/api_spec/.ruby-gemset",
     "lib/api_spec/.ruby-version",
@@ -73,6 +68,7 @@ Gem::Specification.new do |s|
     "lib/nationbuilder/parameter.rb",
     "lib/nationbuilder/spec_parser.rb",
     "lib/nationbuilder/url.rb",
+    "lib/nationbuilder/version.rb",
     "nationbuilder-rb.gemspec",
     "spec/fixtures/delete.yml",
     "spec/fixtures/paginated_get_page2.yml",
@@ -95,14 +91,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httpclient>, ["~> 2.7"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_development_dependency(%q<rake>, ["~> 10.4"])
       s.add_development_dependency(%q<rspec>, ["~> 3.2"])
       s.add_development_dependency(%q<simplecov>, ["~> 0.8"])
       s.add_development_dependency(%q<vcr>, ["~> 2.9"])
       s.add_development_dependency(%q<webmock>, ["~> 1.18"])
     else
       s.add_dependency(%q<httpclient>, ["~> 2.7"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_dependency(%q<rake>, ["~> 10.4"])
       s.add_dependency(%q<rspec>, ["~> 3.2"])
       s.add_dependency(%q<simplecov>, ["~> 0.8"])
       s.add_dependency(%q<vcr>, ["~> 2.9"])
@@ -110,7 +106,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<httpclient>, ["~> 2.7"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    s.add_dependency(%q<rake>, ["~> 10.4"])
     s.add_dependency(%q<rspec>, ["~> 3.2"])
     s.add_dependency(%q<simplecov>, ["~> 0.8"])
     s.add_dependency(%q<vcr>, ["~> 2.9"])

data/spec/lib/nationbuilder/client_spec.rb

@@ -9,6 +9,18 @@ describe NationBuilder::Client do
                               )
   end
 
+  describe '#initialize' do
+    describe 'with a provided httpclient' do
+      let(:httpclient) { double('HTTPClient') }
+
+      subject { described_class.new('slug', 'token', http_client: httpclient) }
+
+      it 'uses the provided client instead of a new one' do
+        expect(subject.instance_variable_get(:@http_client)).to be(httpclient)
+      end
+    end
+  end
+
   describe '#endpoints' do
 
     it 'should contain all defined endpoints' do
@@ -144,16 +156,22 @@ describe NationBuilder::Client do
   end
 
   describe '#perform_request_with_retries' do
-    it 'should raise non-rate limiting execeptions' do
-      expect(HTTPClient).to receive(:send)
+    let(:httpclient) { double('HTTPClient') }
+
+    before do
+      allow(HTTPClient).to receive(:new).and_return(httpclient)
+    end
+
+    it 'should reraise non-rate limiting execeptions' do
+      expect(httpclient).to receive(:send)
       expect(client).to receive(:parse_response_body) { raise StandardError.new('boom') }
       expect do
         client.perform_request_with_retries(nil, nil, nil)
-      end.to raise_error
+      end.to raise_error(StandardError)
     end
 
     it 'should return a response if the rate limit is eventually dropped' do
-      expect(HTTPClient).to receive(:send).twice
+      expect(httpclient).to receive(:send).twice
       expect(Kernel).to receive(:sleep)
 
       allow(client).to receive(:parse_response_body) do
@@ -174,7 +192,7 @@ describe NationBuilder::Client do
     end
 
     it 'on the last retry, it should reraise the rate limiting exception ' do
-      expect(HTTPClient).to receive(:send).twice
+      expect(httpclient).to receive(:send).twice
       expect(Kernel).to receive(:sleep).twice
 
       allow(client).to receive(:parse_response_body) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nationbuilder-rb
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - David Huie
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -26,19 +26,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +115,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - bin/nbdoc
 - lib/api_spec/.ruby-gemset
 - lib/api_spec/.ruby-version
@@ -157,6 +156,7 @@ files:
 - lib/nationbuilder/parameter.rb
 - lib/nationbuilder/spec_parser.rb
 - lib/nationbuilder/url.rb
+- lib/nationbuilder/version.rb
 - nationbuilder-rb.gemspec
 - spec/fixtures/delete.yml
 - spec/fixtures/paginated_get_page2.yml
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Ruby client to the NationBuilder API

data/VERSION

@@ -1 +0,0 @@
-1.4.3