nationbuilder-rb 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2a9e95e72f4cd31b317649c6542b23341ced9d4
-  data.tar.gz: 9151348b994b64949318fe8dd7de00d695c872ff
+  metadata.gz: c7f8f90ebdd85002490a6b397dd09fa46281b8bd
+  data.tar.gz: f9202e8f4eb9dbe9aadf58e573d1bbbaa9e8769e
 SHA512:
-  metadata.gz: 5f36cae292f6a27e6ba670f6afcc04fab0baa13e8e17fa63182338ebce404430c8c192a45ce58cf5db9b048fd5389ac7b2e62b3164c19a4b48a7b4b0ff1fc0f2
-  data.tar.gz: 19b7ba8cb1264bce42ddc1c51898aa93d43c94c9549b3c6fbd06e98deede47316e760c8d1f9fd51fa5494ec746861a3e580e37a68bf7de7cabef28f33885ad93
+  metadata.gz: f98ce91610243f72fdd466c7a005ccbd72d2d53f38141f0efccec999014797ce72e9056cba4dc0abc0bd5d6825693b8297a6b6cb519080b722c220cc80b4c193
+  data.tar.gz: 1cd633b609c6a5bea0127293b1b6b6fed244094b92e7cd8fc836d71dec0bc2a74de1468d993077916ac60a8d6f128c26787c5fe357543980c7ab30422c241fce

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.0
+ruby-2.1.6

data/README.md

@@ -122,3 +122,12 @@ Endpoint: basic_pages
 
 ...
 ```
+
+## Development
+
+To update the API specification that powers this client, first make
+the appropriate updates to the
+[api_spec](https://github.com/nationbuilder/api_spec) repository. Once
+the changes have been merged to api_spec's master branch, run the
+`update_subtree.sh` script in the root directory of this project to
+copy over the changes.

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.3.3

data/lib/api_spec/.ruby-gemset

@@ -0,0 +1 @@
+api_spec

data/lib/api_spec/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.6

data/lib/api_spec/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'rake'

data/lib/api_spec/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+
+BUNDLED WITH
+   1.10.2

data/lib/api_spec/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 NationBuilder.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/api_spec/README.md

@@ -0,0 +1,20 @@
+# api_spec
+This project is centered around generating the `spec.json` file
+located in the root directory. The `spec.json` file contains a machine
+readable specification of the NationBuilder API. It is in Mashery's
+[I/O Docs](http://www.mashery.com/product/io-docs) format. The
+specification can be used to generate documentation servers and client
+libraries for the NationBuilder API.
+
+## Developer environment setup
+
+```ruby
+bundle install
+```
+
+## Adding/modifying an endpoint
+
+Locate the file in `lib/api_spec/specs` that corresponds to the API
+you're modifying. With the DSL used in the file, make your changes. In
+the root project directory, run `rake` to update the `spec.json`
+file. Commit your changes.

data/lib/api_spec/Rakefile

@@ -0,0 +1,9 @@
+$LOAD_PATH << 'lib'
+$LOAD_PATH << 'lib/api_spec'
+
+task :generate_spec do
+  require 'api_spec'
+  ApiSpec::Spec.write_spec('spec.json')
+end
+
+task :default => [:generate_spec]

data/lib/api_spec/lib/api_spec.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module ApiSpec; end
+
+require 'generator'
+
+require 'specs/basic_pages'
+require 'specs/blog_posts'
+require 'specs/blogs'
+require 'specs/calendars'
+require 'specs/campaign_data'
+require 'specs/contacts'
+require 'specs/donations'
+require 'specs/events'
+require 'specs/imports'
+require 'specs/exports'
+require 'specs/lists'
+require 'specs/memberships'
+require 'specs/page_attachments'
+require 'specs/people'
+require 'specs/people_tags'
+require 'specs/precincts'
+require 'specs/sites'
+require 'specs/survey_responses'
+require 'specs/surveys'
+require 'specs/webhooks'

data/lib/api_spec/lib/api_spec/generator.rb

@@ -0,0 +1,113 @@
+module ApiSpec
+  class APIObject
+    class << self
+      attr_accessor :nested_name, :nested_class, :nested_adder_name
+    end
+
+    def nested_name
+      self.class.nested_name
+    end
+
+    def nested_class
+      self.class.nested_class
+    end
+
+    def initialize(name)
+      @name = name
+      send("#{nested_name}=".to_sym, []) if nested_name
+    end
+
+    def to_hash
+      pairs = self.class::JSON_NAMES.map do |name, json_name|
+        [json_name, send(name)]
+      end
+
+      hash = Hash[pairs]
+
+      if nested_name
+        hash[nested_name.to_s] = send(nested_name).map { |obj| obj.to_hash }
+      end
+
+      hash
+    end
+
+    def self.init(base)
+      base.send(:attr_accessor, *base::JSON_NAMES.keys)
+      base.send(:attr_accessor, base.nested_name) if base.nested_name
+      base.send(:define_method, base.nested_adder_name) do |name, &block|
+        obj = nested_class.new(name)
+        block.call(obj)
+        send(nested_name) << obj
+      end if base.nested_adder_name
+    end
+
+  end
+
+  class Parameter < APIObject
+
+    JSON_NAMES = {
+      name: 'Name',
+      required: 'Required',
+      default: 'Default',
+      type: 'Type',
+      description: 'Description'
+    }
+
+    init(self)
+
+  end
+
+  class Method < APIObject
+
+    JSON_NAMES = {
+      name: "MethodName",
+      synopsis: "Synopsis",
+      http_method: "HTTPMethod",
+      uri: "URI"
+    }
+
+    self.nested_name = :parameters
+    self.nested_adder_name = :parameter
+    self.nested_class = Parameter
+
+    init(self)
+
+  end
+
+  class Endpoint < APIObject
+
+    JSON_NAMES = {
+      name: "name",
+    }
+
+    self.nested_name = :methods
+    self.nested_adder_name = :method
+    self.nested_class = ApiSpec::Method
+
+    init(self)
+
+  end
+
+  class Spec < APIObject
+
+    class << self
+      attr_accessor :endpoints
+    end
+
+    self.endpoints = []
+
+    def self.to_hash
+      { 'endpoints' => endpoints.map { |endpoint| endpoint.to_hash } }
+    end
+
+    def self.write_spec(path)
+      File.open(path, 'w') { |f| f.write(JSON.pretty_generate(to_hash)) }
+    end
+
+    def self.endpoint(name)
+      endpoint = Endpoint.new(name)
+      yield endpoint
+      endpoints << endpoint
+    end
+  end
+end

data/lib/api_spec/lib/api_spec/specs/basic_pages.rb

@@ -0,0 +1,106 @@
+class ApiSpec::Spec
+
+  endpoint 'Basic Pages' do |bp|
+
+    bp.method('Index') do |m|
+
+      m.synopsis = "Shows a list of the basic pages in the system"
+      m.http_method = "GET"
+      m.uri = "/sites/:site_slug/pages/basic_pages"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the basic page'
+      end
+
+      m.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      m.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      m.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+
+    end
+
+    bp.method('Create') do |m|
+
+      m.synopsis = "Creates a basic page for a site"
+      m.http_method = "POST"
+      m.uri = "/sites/:site_slug/pages/basic_pages"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the basic page'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'a JSON representation of the new basic page'
+      end
+
+    end
+
+    bp.method('Update') do |m|
+
+      m.synopsis = "Updates the attributes of a basic page"
+      m.http_method = "PUT"
+      m.uri = "/sites/:site_slug/pages/basic_pages/:id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the basic page'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the basic page'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'JSON containing updates'
+      end
+
+    end
+
+    bp.method('Destroy') do |m|
+
+      m.synopsis = "Removes a basic page"
+      m.http_method = "DELETE"
+      m.uri = "/sites/:site_slug/pages/basic_pages/:id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the basic page'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the basic page'
+      end
+
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/blog_posts.rb

@@ -0,0 +1,160 @@
+class ApiSpec::Spec
+
+  endpoint 'Blog Posts' do |bp|
+
+    bp.method('Index') do |m|
+
+      m.synopsis = "Shows a list of blog's posts"
+      m.http_method = "GET"
+      m.uri = "/sites/:site_slug/pages/blogs/:id/posts"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the blog'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the blog'
+      end
+
+      m.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      m.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      m.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+
+    end
+
+    bp.method('Match') do |m|
+
+      m.synopsis = "Find a blog post by its external id"
+      m.http_method = "GET"
+      m.uri = "/sites/:site_slug/pages/blogs/:id/match"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the blog'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the blog'
+      end
+
+      m.parameter('external_id') do |p|
+        p.required = 'N'
+        p.default = '1'
+        p.type = 'int'
+        p.description = 'the external id of the post'
+      end
+
+    end
+
+    bp.method('Create') do |m|
+
+      m.synopsis = "Creates a new blog post"
+      m.http_method = "POST"
+      m.uri = "/sites/:site_slug/pages/blogs/:blog_id/posts"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the blog'
+      end
+
+      m.parameter('blog_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the blog'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '1'
+        p.type = 'json'
+        p.description = 'a JSON representation of the new post'
+      end
+
+    end
+
+    bp.method('Update') do |m|
+
+      m.synopsis = "Updates the attributes of a blog post"
+      m.http_method = "PUT"
+      m.uri = "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the blog'
+      end
+
+      m.parameter('blog_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the blog'
+      end
+
+      m.parameter('blog_post_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the blog'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '1'
+        p.type = 'json'
+        p.description = 'JSON containing updates'
+      end
+
+    end
+
+    bp.method('Destroy') do |m|
+
+      m.synopsis = "Removes a blog post"
+      m.http_method = "DELETE"
+      m.uri = "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the blog'
+      end
+
+      m.parameter('blog_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the blog'
+      end
+
+      m.parameter('blog_post_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the blog'
+      end
+
+
+    end
+
+  end
+
+end