nationbuilder-rb 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7d90522e1da3706355c4384564ce4d013e5157c9
-  data.tar.gz: 9b90174d74c34961e5c0182723c69f18c189be11
+SHA256:
+  metadata.gz: fa19aac9206353be46c51cc1da4ffe85900ede423561f5088522cd87247deebd
+  data.tar.gz: 52de4115b379d3dd190c64e6d8caae4992cbaf66d68010790dc4f2d3e790ebff
 SHA512:
-  metadata.gz: 74c9fe8815fbbe6b6c249701953995a5af9f82f3db7cde9fa925acea0d197d225f749518507523a7bd3aaebe226e6619db80e7c88bcf246ddb3340d7f01d707a
-  data.tar.gz: 8058d962e097dc7a4353ca00bcdbc4fe7a7a58bf8cdb7422f97f0dbaa565c1694ac90f442f5dc3e9b2a494e631284b611f3a73bcbf1f51ea2ebbef3c29dcfbe0
+  metadata.gz: 8aa4e1c4ac464310c14e7f3e6c01d2ff1d8fd13cb2f759fff6cdba79e621e0fdc85a4e4a46029fd445d3ba638028d8aa8e4e7fc7a44cb31c901e2816b890a5fc
+  data.tar.gz: 2154343718733e691c2aa242b5603a4bcf94216c4b3ca6dc9b2de3ab1cab3f09fbcbb8a85a030615b1c0b9ac7d5853f0cdfa37f12867159dc67a8a2ca9335aa2

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.6
+ruby-2.5.3

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-  - 2.1.0
-  - 2.2.5
-  - 2.3.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
 before_script: bundle install
 script: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.6.2
+- [#46] Pass access token via header instead of query params
+- [#45] Fix query params for searching custom fields on people#search
+
 # 1.6.0
 - [#40] Remove appending `status_code` to the parsed response and ensure
   the `response` for the last request is always accessible via the client

data/Gemfile

@@ -3,9 +3,9 @@ source 'https://rubygems.org'
 gem 'httpclient', '~> 2.7'
 
 group :development do
-  gem 'rake', '~> 10.4'
-  gem 'rspec', '~> 3.2'
-  gem 'simplecov', '~> 0.8'
-  gem 'vcr', '~> 2.9'
-  gem 'webmock', '~> 1.18'
+  gem 'rake', '~> 12.3'
+  gem 'rspec', '~> 3.8'
+  gem 'simplecov', '~> 0.16'
+  gem 'vcr', '~> 4.0'
+  gem 'webmock', '~> 3.4'
 end

data/Gemfile.lock

@@ -1,48 +1,52 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.7)
-    crack (0.4.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    httpclient (2.7.0.1)
-    multi_json (1.10.1)
-    rake (10.5.0)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.0)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hashdiff (0.3.7)
+    httpclient (2.8.3)
+    json (2.1.0)
+    public_suffix (3.0.3)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     safe_yaml (1.0.4)
-    simplecov (0.9.1)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    vcr (2.9.3)
-    webmock (1.20.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    vcr (4.0.0)
+    webmock (3.4.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   httpclient (~> 2.7)
-  rake (~> 10.4)
-  rspec (~> 3.2)
-  simplecov (~> 0.8)
-  vcr (~> 2.9)
-  webmock (~> 1.18)
+  rake (~> 12.3)
+  rspec (~> 3.8)
+  simplecov (~> 0.16)
+  vcr (~> 4.0)
+  webmock (~> 3.4)
 
 BUNDLED WITH
-   1.13.6
+   1.16.4

data/lib/nationbuilder.rb

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

data/lib/nationbuilder/client.rb

@@ -45,18 +45,16 @@ class NationBuilder::Client
 
     request_args = {
       header: {
-        'Accept' => 'application/json',
-        'Content-Type' => 'application/json'
+        'Accept'        => 'application/json',
+        'Content-Type'  => 'application/json',
+        'Authorization' => "Bearer #{@api_key}"
       },
-      query: {
-        access_token: @api_key
-      }
+      query: {}
     }
 
     if method == :get
-      request_args[:query].merge!(body)
+      request_args[:query].merge!(NationBuilder::Utils::QueryParams.encode(body))
     else
-      body[:access_token] = @api_key
       if !body[:fire_webhooks].nil?
         request_args[:query][:fire_webhooks] = body[:fire_webhooks]
       end

data/lib/nationbuilder/method.rb

@@ -30,19 +30,15 @@ class NationBuilder::Method
   end
 
   def method_args(args)
-    a = {}
-    args.each do |k, v|
-        a[k] = v if parameters.include?(k)
+    args.each_with_object({}) do |(k, v), a|
+      a[k] = v if parameters.include?(k)
     end
-    a
   end
 
   def nonmethod_args(args)
-    a = {}
-    args.each do |k, v|
-        a[k] = v unless parameters.include?(k)
+    args.each_with_object({}) do |(k, v), a|
+      a[k] = v unless parameters.include?(k)
     end
-    a
   end
 
 end

data/lib/nationbuilder/paginator.rb

@@ -14,7 +14,7 @@ class NationBuilder::Paginator
     define_method(:"#{page_type}") do |call_body = {}|
       return nil unless send(:"#{page_type}?")
       path = send(:"#{page_type}?").split('/api/v1').last
-      call_body[:limit] ||= CGI.parse(path)['limit']
+      call_body[:limit] ||= CGI.parse(path)['limit'][0]
       results = @client.raw_call(path, :get, call_body)
       return self.class.new(@client, results)
     end

data/lib/nationbuilder/spec_parser.rb

@@ -2,9 +2,8 @@ class NationBuilder::SpecParser
 
   def self.parse(spec_path)
     spec = JSON.parse(File.read(spec_path))
-    endpoints = []
 
-    spec['endpoints'].each do |endpoint|
+    spec['endpoints'].each_with_object([]) do |endpoint, endpoints|
       nb_endpoint = NationBuilder::Endpoint.new(endpoint['name'])
       endpoints << nb_endpoint
       endpoint['methods'].each do |method|
@@ -22,7 +21,6 @@ class NationBuilder::SpecParser
       end
     end
 
-    endpoints
   end
 
 end

data/lib/nationbuilder/utils.rb

@@ -0,0 +1,22 @@
+module NationBuilder::Utils
+  module QueryParams
+    module_function
+
+    def encode(value, key = nil, output = {})
+      case value
+      when Hash  then value.each { |k, v| encode(v, append_key(key, k), output) }
+      when Array then value.each { |v|    encode(v, "#{key}[]", output) }
+      when nil   then ''
+      else
+        output[key] = value
+      end
+      output
+    end
+
+    def append_key(root_key, key)
+      root_key.nil? ? "#{key}" : "#{root_key}[#{key}]"
+    end
+
+    private_class_method :append_key
+  end
+end

data/lib/nationbuilder/version.rb

@@ -1,5 +1,5 @@
 module NationBuilder
 
-  VERSION = '1.6.1'.freeze
+  VERSION = '1.6.2'.freeze
 
 end

data/nationbuilder-rb.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   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 = "2017-11-22"
+  s.date = "2018-12-27"
   s.description = "A Ruby client to the NationBuilder API"
-  s.email = "schmitt@nationbuilder.com"
+  s.email = "api@nationbuilder.com"
   s.executables = ["nbdoc"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -68,9 +68,12 @@ Gem::Specification.new do |s|
     "lib/nationbuilder/parameter.rb",
     "lib/nationbuilder/spec_parser.rb",
     "lib/nationbuilder/url.rb",
+    "lib/nationbuilder/utils.rb",
     "lib/nationbuilder/version.rb",
     "nationbuilder-rb.gemspec",
     "spec/fixtures/delete.yml",
+    "spec/fixtures/errored_get.yml",
+    "spec/fixtures/paginated_get.yml",
     "spec/fixtures/paginated_get_page2.yml",
     "spec/fixtures/paginated_get_page2_with_limit.yml",
     "spec/fixtures/paginated_get_page3.yml",
@@ -78,6 +81,7 @@ Gem::Specification.new do |s|
     "spec/fixtures/parametered_post.yml",
     "spec/lib/nationbuilder/client_spec.rb",
     "spec/lib/nationbuilder/paginator_spec.rb",
+    "spec/lib/nationbuilder/utils_spec.rb",
     "spec/spec_helper.rb",
     "update_subtree.sh"
   ]
@@ -91,25 +95,25 @@ 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<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"])
+      s.add_development_dependency(%q<rake>, ["~> 12.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.8"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.16"])
+      s.add_development_dependency(%q<vcr>, ["~> 4.0"])
+      s.add_development_dependency(%q<webmock>, ["~> 3.4"])
     else
       s.add_dependency(%q<httpclient>, ["~> 2.7"])
-      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"])
-      s.add_dependency(%q<webmock>, ["~> 1.18"])
+      s.add_dependency(%q<rake>, ["~> 12.3"])
+      s.add_dependency(%q<rspec>, ["~> 3.8"])
+      s.add_dependency(%q<simplecov>, ["~> 0.16"])
+      s.add_dependency(%q<vcr>, ["~> 4.0"])
+      s.add_dependency(%q<webmock>, ["~> 3.4"])
     end
   else
     s.add_dependency(%q<httpclient>, ["~> 2.7"])
-    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"])
-    s.add_dependency(%q<webmock>, ["~> 1.18"])
+    s.add_dependency(%q<rake>, ["~> 12.3"])
+    s.add_dependency(%q<rspec>, ["~> 3.8"])
+    s.add_dependency(%q<simplecov>, ["~> 0.16"])
+    s.add_dependency(%q<vcr>, ["~> 4.0"])
+    s.add_dependency(%q<webmock>, ["~> 3.4"])
   end
 end

data/spec/fixtures/delete.yml

@@ -2,38 +2,42 @@
 http_interactions:
 - request:
     method: delete
-    uri: https://organizeralexandreschmitt.nationbuilder.com/api/v1/people/278881?access_token=03c22256c06ed11f6bee83673addf26e02a86caa1a5127f4e0815be7223fe4a3
+    uri: https://testnation.nationbuilder.com/api/v1/people/278881
     body:
       encoding: UTF-8
-      string: '{"access_token":"03c22256c06ed11f6bee83673addf26e02a86caa1a5127f4e0815be7223fe4a3"}'
+      string: "{}"
     headers:
       User-Agent:
-      - HTTPClient/1.0 (2.7.0.1, ruby 2.1.6 (2015-04-13))
+      - HTTPClient/1.0 (2.7.0.1, ruby 2.5.1 (2018-03-29))
       Accept:
       - application/json
       Date:
-      - Wed, 23 Nov 2016 19:16:47 GMT
+      - Tue, 30 Oct 2018 20:21:54 GMT
       Content-Type:
       - application/json
+      Authorization:
+      - Bearer 03c22256c06ed11f6bee83673addf26e02a86caa1a5127f4e0815be7223fe4a3
   response:
     status:
       code: 204
       message: No Content
     headers:
-      Server:
-      - Apache/2.4.7 (Ubuntu)
       Nation-Ratelimit-Limit:
       - '999999'
       Nation-Ratelimit-Remaining:
       - '999999'
       Nation-Ratelimit-Reset:
-      - '1479945600'
+      - '1540944000'
+      Server:
+      - Apache/2.4.7 (Ubuntu)
       Status:
       - 204 No Content
       X-Content-Type-Options:
       - nosniff
       X-Frame-Options:
-      - SAMEORIGIN
+      - ALLOWALL
+      X-Middleware-Start:
+      - t=1540930915181995
       X-Powered-By:
       - Phusion Passenger Enterprise 5.0.28
       X-Pulse-Approved:
@@ -45,30 +49,28 @@ http_interactions:
       X-Ratelimit-Remaining:
       - '99'
       X-Ratelimit-Reset:
-      - '1479928618'
+      - '1540930925'
       X-Request-Id:
-      - 48920c47-e280-436b-9a98-36fa47402ce9
+      - eabac74f-2db5-4709-978c-bbf60720df1e
       X-Runtime:
-      - '1.202383'
-      X-Xss-Protection:
-      - 1; mode=block
-      Content-Length:
-      - '0'
+      - '1.301545'
+      X-Served-By:
+      - api11
       Expires:
-      - Wed, 23 Nov 2016 19:16:49 GMT
+      - Tue, 30 Oct 2018 20:21:56 GMT
       Cache-Control:
       - max-age=0, no-cache, no-store
       Pragma:
       - no-cache
       Date:
-      - Wed, 23 Nov 2016 19:16:49 GMT
+      - Tue, 30 Oct 2018 20:21:56 GMT
       Connection:
       - keep-alive
-      Set-Cookie:
-      - _cookies_enabled=1479928609; path=/
+      Use-Proxy:
+      - 'True'
     body:
       encoding: UTF-8
       string: ''
-    http_version: 
-  recorded_at: Wed, 23 Nov 2016 19:16:49 GMT
+    http_version:
+  recorded_at: Tue, 30 Oct 2018 20:21:56 GMT
 recorded_with: VCR 2.9.3

data/spec/fixtures/errored_get.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://testnation.nationbuilder.com/api/v1/people/0
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.7.0.1, ruby 2.5.1 (2018-03-29))
+      Accept:
+      - application/json
+      Date:
+      - Tue, 30 Oct 2018 20:20:39 GMT
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer 03c22256c06ed11f6bee83673addf26e02a86caa1a5127f4e0815be7223fe4a3
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Nation-Ratelimit-Limit:
+      - '999999'
+      Nation-Ratelimit-Remaining:
+      - '999999'
+      Nation-Ratelimit-Reset:
+      - '1540944000'
+      Server:
+      - Apache/2.4.7 (Ubuntu)
+      Status:
+      - 404 Not Found
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - ALLOWALL
+      X-Middleware-Start:
+      - t=1540930839625416
+      X-Powered-By:
+      - Phusion Passenger Enterprise 5.0.28
+      X-Pulse-Approved:
+      - 'true'
+      X-Rack-Cache:
+      - miss
+      X-Ratelimit-Limit:
+      - 10s
+      X-Ratelimit-Remaining:
+      - '98'
+      X-Ratelimit-Reset:
+      - '1540930848'
+      X-Request-Id:
+      - b89dc2fd-2a92-425c-9c60-228e3bf634c9
+      X-Runtime:
+      - '0.067800'
+      X-Served-By:
+      - api12
+      Content-Length:
+      - '49'
+      Expires:
+      - Tue, 30 Oct 2018 20:20:39 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store
+      Pragma:
+      - no-cache
+      Date:
+      - Tue, 30 Oct 2018 20:20:39 GMT
+      Connection:
+      - keep-alive
+      Use-Proxy:
+      - 'True'
+    body:
+      encoding: UTF-8
+      string: '{"code":"not_found","message":"Record not found"}'
+    http_version: 
+  recorded_at: Tue, 30 Oct 2018 20:20:39 GMT
+recorded_with: VCR 2.9.3