nationbuilder-rb 0.0.1

data/lib/nationbuilder/client.rb

@@ -0,0 +1,97 @@
+class NationBuilder::Client
+
+  def initialize(nation_name, api_key)
+    @nation_name = nation_name
+    @api_key = api_key
+    @name_to_endpoint = {}
+    parsed_endpoints.each do |endpoint|
+      @name_to_endpoint[endpoint.name] = endpoint
+    end
+  end
+
+  def parsed_endpoints
+    NationBuilder::SpecParser
+      .parse(File.join(File.dirname(__FILE__), 'api_spec.json'))
+  end
+
+  def [](endpoint)
+    @name_to_endpoint[endpoint]
+  end
+
+  def endpoints
+    @name_to_endpoint.keys
+  end
+
+  def base_url
+    @base_url ||=
+      NationBuilder::URL_TEMPLATE.gsub(':nation_name', @nation_name)
+  end
+
+  def call(endpoint_name, method_name, args={})
+    endpoint = self[endpoint_name]
+    method = endpoint[method_name]
+    nonmethod_args = method.nonmethod_args(args)
+    method_args = method.method_args(args)
+    method.validate_args(method_args)
+    url = NationBuilder.generate_url(base_url, method.uri, method_args)
+
+    request_args = {
+      header: {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+    }
+
+    if method.http_method == :get
+      request_args[:query] = nonmethod_args
+      request_args[:query][:access_token] = @api_key
+    else
+      nonmethod_args[:access_token] = @api_key
+      request_args[:body] = JSON(nonmethod_args)
+    end
+
+    response = HTTPClient.send(method.http_method, url, request_args)
+    return parse_response_body(response)
+  end
+
+  class ServerResponseError < StandardError; end
+
+  def parse_response_body(response)
+    success = response.code.to_s.start_with?('2')
+
+    if response.header['Content-Type'].first != 'application/json'
+      return {} if success
+      raise ServerResponseError.new("Non-JSON content-type for server response: #{response.body}")
+    end
+
+    body = response.body.strip
+    return {} if body.length == 0
+    return JSON.parse(body)
+  end
+
+  def print_all_descriptions
+    endpoints.each do |endpoint_name|
+      self.print_description(endpoint_name)
+      puts
+    end
+  end
+
+  def print_description(endpoint_name)
+    endpoint_str = "Endpoint: #{endpoint_name}"
+    puts "=" * endpoint_str.length
+    puts endpoint_str
+    puts "=" * endpoint_str.length
+
+    self[endpoint_name.to_sym].methods.each do |method_name|
+      puts
+      method = self[endpoint_name][method_name]
+      puts "  Method: #{method_name.inspect}"
+      puts "  Description: #{method.description}"
+      required_params = method.parameters.map { |p| p.inspect }
+      if required_params.any?
+        puts "  Required parameters: #{required_params.join(', ')}"
+      end
+    end
+  end
+
+end

data/lib/nationbuilder/endpoint.rb

@@ -0,0 +1,24 @@
+class NationBuilder::Endpoint
+
+  def initialize(name)
+    @name = name
+    @name_to_method = {}
+  end
+
+  def name
+    @name.downcase.gsub(' ', '_').to_sym
+  end
+
+  def register_method(method)
+    @name_to_method[method.name] = method
+  end
+
+  def methods
+    @methods ||= @name_to_method.keys
+  end
+
+  def [](method_name)
+    @name_to_method[method_name]
+  end
+
+end

data/lib/nationbuilder/method.rb

@@ -0,0 +1,48 @@
+class NationBuilder::Method
+
+  attr_reader :uri, :http_method, :description
+
+  def initialize(name, http_method, uri, description)
+    @name = name
+    @http_method = http_method.downcase.to_sym
+    @uri = uri
+    @description = description
+    @name_to_parameter = {}
+  end
+
+  def register_parameter(parameter)
+    @name_to_parameter[parameter.name] = parameter
+  end
+
+  def parameters
+    @name_to_parameter.keys
+  end
+
+  def name
+    @name.downcase.gsub(' ', '_').to_sym
+  end
+
+  def validate_args(args)
+    if Set.new(args.keys) != Set.new(parameters)
+      raise ArgumentError
+        .new("Required args: #{parameters.join(', ')}. Provided args: #{args.keys.join(', ')}")
+    end
+  end
+
+  def method_args(args)
+    a = {}
+    args.each do |k, v|
+        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)
+    end
+    a
+  end
+
+end

data/lib/nationbuilder/parameter.rb

@@ -0,0 +1,9 @@
+class NationBuilder::Parameter
+
+  attr_reader :name
+
+  def initialize(name)
+    @name = name.to_sym
+  end
+
+end

data/lib/nationbuilder/spec_parser.rb

@@ -0,0 +1,28 @@
+class NationBuilder::SpecParser
+
+  def self.parse(spec_path)
+    spec = JSON.parse(File.read(spec_path))
+    endpoints = []
+
+    spec['endpoints'].each do |endpoint|
+      nb_endpoint = NationBuilder::Endpoint.new(endpoint['name'])
+      endpoints << nb_endpoint
+      endpoint['methods'].each do |method|
+        nb_method = NationBuilder::Method.new(method['MethodName'],
+                                              method['HTTPMethod'],
+                                              method['URI'],
+                                              method['Synopsis'])
+        nb_endpoint.register_method(nb_method)
+        method['parameters'].each do |parameter|
+          if (parameter['Required'] == 'Y') && (parameter['Name'] != 'body')
+            nb_parameter = NationBuilder::Parameter.new(parameter['Name'])
+            nb_method.register_parameter(nb_parameter)
+          end
+        end
+      end
+    end
+
+    endpoints
+  end
+
+end

data/nationbuilder-rb.gemspec

@@ -0,0 +1,80 @@
+# 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 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "nationbuilder-rb"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Huie"]
+  s.date = "2014-06-26"
+  s.description = "A Ruby client to the NationBuilder API"
+  s.email = "david@nationbuilder.com"
+  s.executables = ["nbdoc"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".ruby-gemset",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/nbdoc",
+    "lib/nationbuilder.rb",
+    "lib/nationbuilder/api_spec.json",
+    "lib/nationbuilder/client.rb",
+    "lib/nationbuilder/endpoint.rb",
+    "lib/nationbuilder/method.rb",
+    "lib/nationbuilder/parameter.rb",
+    "lib/nationbuilder/spec_parser.rb",
+    "nationbuilder-rb.gemspec",
+    "spec/fixtures/delete.yml",
+    "spec/fixtures/parametered_get.yml",
+    "spec/fixtures/parametered_post.yml",
+    "spec/fixtures/parametered_put.yml",
+    "spec/nationbuilder_client_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/3dna/nationbuilder-rb"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.11"
+  s.summary = "A Ruby client to the NationBuilder API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httpclient>, ["~> 2.4.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.8.2"])
+      s.add_development_dependency(%q<vcr>, ["~> 2.9.2"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.18.0"])
+    else
+      s.add_dependency(%q<httpclient>, ["~> 2.4.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<simplecov>, ["~> 0.8.2"])
+      s.add_dependency(%q<vcr>, ["~> 2.9.2"])
+      s.add_dependency(%q<webmock>, ["~> 1.18.0"])
+    end
+  else
+    s.add_dependency(%q<httpclient>, ["~> 2.4.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<simplecov>, ["~> 0.8.2"])
+    s.add_dependency(%q<vcr>, ["~> 2.9.2"])
+    s.add_dependency(%q<webmock>, ["~> 1.18.0"])
+  end
+end
+

data/spec/fixtures/delete.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://dh.nationbuilder.com/api/v1/people/15
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"6e516b5d9a3d21b3cc079bc303c01aae3d59c8d4a7e9e6d2acfc11dada0e054e"}'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.4.0, ruby 2.0.0 (2013-11-22))
+      Accept:
+      - application/json
+      Date:
+      - Wed, 25 Jun 2014 22:41:37 GMT
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Wed, 25 Jun 2014 22:41:39 GMT
+      Content-Type:
+      - application/octet-stream
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d4ac3918ff3dbcc509787eadf8b8b90451403736098139; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.nationbuilder.com; HttpOnly
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - no-cache
+      Nation-Ratelimit-Limit:
+      - '10000'
+      Nation-Ratelimit-Remaining:
+      - '9968'
+      Nation-Ratelimit-Reset:
+      - '1403740800'
+      X-Request-Id:
+      - f00da219be79923c08a78e821cc4897b
+      X-Runtime:
+      - '0.994571'
+      X-Rack-Cache:
+      - invalidate, pass
+      X-Powered-By:
+      - Phusion Passenger 4.0.23
+      Status:
+      - 204 No Content
+      Via:
+      - 1.1 nationbuilder.com
+      Cf-Ray:
+      - 1404ac75519c0d67-LAX
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Wed, 25 Jun 2014 22:41:39 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/parametered_get.yml

@@ -0,0 +1,79 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://dh.nationbuilder.com/api/v1/sites/dh/pages/basic_pages?access_token=6e516b5d9a3d21b3cc079bc303c01aae3d59c8d4a7e9e6d2acfc11dada0e054e
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.4.0, ruby 2.0.0 (2013-11-22))
+      Accept:
+      - application/json
+      Date:
+      - Wed, 25 Jun 2014 22:28:30 GMT
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Wed, 25 Jun 2014 22:28:31 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d32a8837f08e39176e4d1ed146327e7201403735310572; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.nationbuilder.com; HttpOnly
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Nation-Ratelimit-Limit:
+      - '10000'
+      Nation-Ratelimit-Remaining:
+      - '9973'
+      Nation-Ratelimit-Reset:
+      - '1403740800'
+      X-Request-Id:
+      - c833875bc9d08cf43ca93454d0a4f70f
+      X-Runtime:
+      - '0.697364'
+      X-Rack-Cache:
+      - miss
+      X-Powered-By:
+      - Phusion Passenger 4.0.23
+      Status:
+      - 200 OK
+      Vary:
+      - Accept-Encoding
+      Via:
+      - 1.1 nationbuilder.com
+      Cf-Ray:
+      - 1404993b14380d67-LAX
+    body:
+      encoding: UTF-8
+      string: '{"page":1,"total_pages":1,"per_page":10,"total":1,"results":[{"slug":"about","path":"/about","status":"published","site_slug":"dh","name":"About","headline":"About","title":"About
+        - dh","excerpt":"","author_id":2,"published_at":"2013-07-08T11:07:00-07:00","external_id":null,"tags":[],"id":1,"content":"<div
+        style=\"float: right; margin: 0 0 10px 25px;\"><img class=\"img-circle\" src=\"boats.jpg\"
+        alt=\"\"></div>\r\n<p>This is where you tell everyone what your blog is about.
+        Explain what the intended purpose of your blog is, if there is one. If multiple
+        people will be writing for your blog, you might consider posting photos and
+        bios of the contributors.</p>\r\n<p>Proin libero diam, consequat ut nisl vestibulum,
+        commodo scelerisque lacus. In vehicula, est quis rhoncus tristique, dolor
+        sapien aliquam arcu, ut vulputate quam enim quis augue. Phasellus id nunc
+        vitae lectus dapibus viverra malesuada at nibh. Suspendisse sagittis odio
+        non ipsum feugiat porta.</p>\r\n<p>\u00a0</p>\r\n<p><strong>To change this
+        content, click \"Edit this page\" in the Supporter Nav on the right,<br>or
+        from your Control Panel navigate to Websites &gt; [about] &gt; Content.</strong></p>"}]}'
+    http_version: 
+  recorded_at: Wed, 25 Jun 2014 22:28:31 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/parametered_post.yml

@@ -0,0 +1,68 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://dh.nationbuilder.com/api/v1/people
+    body:
+      encoding: UTF-8
+      string: '{"person":{"email":"bob@example.com","last_name":"Smith","first_name":"Bob"},"access_token":"6e516b5d9a3d21b3cc079bc303c01aae3d59c8d4a7e9e6d2acfc11dada0e054e"}'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.4.0, ruby 2.0.0 (2013-11-22))
+      Accept:
+      - application/json
+      Date:
+      - Wed, 25 Jun 2014 22:35:22 GMT
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Wed, 25 Jun 2014 22:35:22 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d184a711d4f638864b5e1fa438601ebdc1403735721919; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.nationbuilder.com; HttpOnly
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Nation-Ratelimit-Limit:
+      - '10000'
+      Nation-Ratelimit-Remaining:
+      - '9972'
+      Nation-Ratelimit-Reset:
+      - '1403740800'
+      X-Request-Id:
+      - 34e7f148285faf579d2885dee6cb5571
+      X-Runtime:
+      - '0.715257'
+      X-Rack-Cache:
+      - invalidate, pass
+      X-Powered-By:
+      - Phusion Passenger 4.0.23
+      Status:
+      - 201 Created
+      Vary:
+      - Accept-Encoding
+      Via:
+      - 1.1 nationbuilder.com
+      Cf-Ray:
+      - 1404a345f7b20d67-LAX
+    body:
+      encoding: UTF-8
+      string: '{"person":{"birthdate":null,"city_district":null,"civicrm_id":null,"county_district":null,"county_file_id":null,"created_at":"2014-06-25T15:35:22-07:00","do_not_call":false,"do_not_contact":false,"dw_id":null,"email":"bob@example.com","email_opt_in":true,"employer":null,"external_id":null,"federal_district":null,"fire_district":null,"first_name":"Bob","has_facebook":false,"id":15,"is_twitter_follower":false,"is_volunteer":false,"judicial_district":null,"labour_region":null,"last_name":"Smith","linkedin_id":null,"mobile":null,"mobile_opt_in":true,"nbec_guid":null,"ngp_id":null,"note":null,"occupation":null,"party":null,"pf_strat_id":null,"phone":null,"precinct_id":null,"primary_address":null,"recruiter_id":null,"rnc_id":null,"rnc_regid":null,"salesforce_id":null,"school_district":null,"school_sub_district":null,"sex":null,"state_file_id":null,"state_lower_district":null,"state_upper_district":null,"support_level":null,"supranational_district":null,"tags":[],"twitter_id":null,"twitter_name":null,"updated_at":"2014-06-25T15:35:22-07:00","van_id":null,"village_district":null,"active_customer_expires_at":null,"active_customer_started_at":null,"author":null,"author_id":null,"auto_import_id":null,"availability":null,"banned_at":null,"billing_address":null,"bio":null,"call_status_id":null,"call_status_name":null,"capital_amount_in_cents":0,"children_count":0,"church":null,"city_sub_district":null,"closed_invoices_amount_in_cents":null,"closed_invoices_count":null,"contact_status_id":null,"contact_status_name":null,"could_vote_status":null,"demo":null,"donations_amount_in_cents":0,"donations_amount_this_cycle_in_cents":0,"donations_count":0,"donations_count_this_cycle":0,"donations_pledged_amount_in_cents":0,"donations_raised_amount_in_cents":0,"donations_raised_amount_this_cycle_in_cents":0,"donations_raised_count":0,"donations_raised_count_this_cycle":0,"donations_to_raise_amount_in_cents":0,"email1":"bob@example.com","email1_is_bad":false,"email2":null,"email2_is_bad":false,"email3":null,"email3_is_bad":false,"email4":null,"email4_is_bad":false,"ethnicity":null,"facebook_address":null,"facebook_profile_url":null,"facebook_updated_at":null,"facebook_username":null,"fax_number":null,"federal_donotcall":false,"first_donated_at":null,"first_fundraised_at":null,"first_invoice_at":null,"first_prospect_at":null,"first_recruited_at":null,"first_supporter_at":"2014-06-25T15:35:22-07:00","first_volunteer_at":null,"full_name":"Bob
+        Smith","home_address":null,"import_id":null,"inferred_party":null,"inferred_support_level":null,"invoice_payments_amount_in_cents":0,"invoice_payments_referred_amount_in_cents":0,"invoices_amount_in_cents":null,"invoices_count":null,"is_deceased":false,"is_donor":false,"is_fundraiser":false,"is_ignore_donation_limits":false,"is_leaderboardable":true,"is_mobile_bad":false,"is_possible_duplicate":false,"is_profile_private":false,"is_profile_searchable":true,"is_prospect":false,"is_supporter":true,"is_survey_question_private":false,"language":null,"last_call_id":null,"last_contacted_at":null,"last_contacted_by":null,"last_donated_at":null,"last_fundraised_at":null,"last_invoice_at":null,"last_rule_violation_at":null,"legal_name":null,"locale":null,"mailing_address":null,"marital_status":null,"media_market_name":null,"meetup_address":null,"membership_expires_at":null,"membership_level_name":null,"membership_started_at":null,"middle_name":null,"mobile_normalized":null,"nbec_precinct_code":null,"note_updated_at":null,"outstanding_invoices_amount_in_cents":null,"outstanding_invoices_count":null,"overdue_invoices_count":0,"page_slug":null,"parent":null,"parent_id":null,"party_member":false,"phone_normalized":null,"phone_time":null,"precinct_code":null,"precinct_name":null,"prefix":null,"previous_party":null,"primary_email_id":1,"priority_level":null,"priority_level_changed_at":null,"profile_content":null,"profile_content_html":null,"profile_headline":null,"received_capital_amount_in_cents":0,"recruiter":null,"recruits_count":0,"registered_address":null,"registered_at":null,"religion":null,"rule_violations_count":0,"spent_capital_amount_in_cents":0,"submitted_address":null,"subnations":[],"suffix":null,"support_level_changed_at":null,"support_probability_score":null,"turnout_probability_score":null,"twitter_address":null,"twitter_description":null,"twitter_followers_count":null,"twitter_friends_count":null,"twitter_location":null,"twitter_login":null,"twitter_updated_at":null,"twitter_website":null,"unsubscribed_at":null,"user_submitted_address":null,"username":null,"warnings_count":0,"website":null,"work_address":null,"work_phone_number":null},"precinct":null}'
+    http_version: 
+  recorded_at: Wed, 25 Jun 2014 22:35:23 GMT
+recorded_with: VCR 2.9.2