nationbuilder-rb 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74725e766258bbda70bc52329f7b9cadb7283cdb
-  data.tar.gz: 87eceb294433899c5c3c47408401c18f4a0737f5
+  metadata.gz: 75502cce5322b23668e6ece025184f010aaaf8d8
+  data.tar.gz: 226c8b916c20d808b7499056dbd628bf378b05b7
 SHA512:
-  metadata.gz: 50e4516b6eb50f2d044ce80a4779a20b07f788f00eb762712d471725fcfa13e781a55e71441d8aeeea3c613c0e356a1e43c7d3fb203b75b3dcfe34388067764d
-  data.tar.gz: 4d4647dadcc464a77dc807ac4c7321224dd76a692ffe7d7bcdca4dc30dc9ef323cd2a0a77ac936e668ecf2d41ba10d0d37d21896db25c17363730e5fd5bef1e6
+  metadata.gz: af24d213363b8dd87665e2be320730bc45262127cfb3ab961364382f90a47f74a15945ee56a14f72f3015a40f0aae35d8ece2bbdbdab47528fca377a760ce869
+  data.tar.gz: 7f77e212410056a9db54a6ac350233d44bf220cc6716e59003d53131bb3ea98413826867a97b9e687e262097f41923e48de981baab341c99c2c4cfbdbceb70dd

data/README.md

@@ -94,12 +94,13 @@ $ nbdoc basic_pages
 Endpoint: basic_pages
 =====================
 
-  Method: :index
+  Method: index
   Description: Shows a list of the basic pages in the system
-  Required parameters: :site_slug
+  Required parameters: site_slug
 
-  Method: :create
+  Method: create
   Description: Creates a basic page for a site
-  Required parameters: :site_slug
+  Required parameters: site_slug
+
 ...
 ```

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/lib/nationbuilder/api_spec.json

@@ -108,13 +108,13 @@
       ]
     },
     {
-      "name": "Blogs",
+      "name": "Blog Posts",
       "methods": [
         {
           "MethodName": "Index",
-          "Synopsis": "Shows a list of all blogs",
+          "Synopsis": "Shows a list of blog's posts",
           "HTTPMethod": "GET",
-          "URI": "/sites/:site_slug/pages/blogs",
+          "URI": "/sites/:site_slug/pages/blogs/:id/posts",
           "parameters": [
             {
               "Name": "site_slug",
@@ -123,6 +123,13 @@
               "Type": "string",
               "Description": "the site holding the blog"
             },
+            {
+              "Name": "id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "the ID of the blog"
+            },
             {
               "Name": "page",
               "Required": "N",
@@ -140,10 +147,10 @@
           ]
         },
         {
-          "MethodName": "Show",
-          "Synopsis": "Show the details of a blog",
+          "MethodName": "Match",
+          "Synopsis": "Find a blog post by its external id",
           "HTTPMethod": "GET",
-          "URI": "/sites/:site_slug/pages/blogs/:id",
+          "URI": "/sites/:site_slug/pages/blogs/:id/match",
           "parameters": [
             {
               "Name": "site_slug",
@@ -158,14 +165,21 @@
               "Default": null,
               "Type": "int",
               "Description": "the ID of the blog"
+            },
+            {
+              "Name": "external_id",
+              "Required": "N",
+              "Default": "1",
+              "Type": "int",
+              "Description": "the external id of the post"
             }
           ]
         },
         {
           "MethodName": "Create",
-          "Synopsis": "Creates a new blog",
+          "Synopsis": "Creates a new blog post",
           "HTTPMethod": "POST",
-          "URI": "/sites/:site_slug/pages/blogs",
+          "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts",
           "parameters": [
             {
               "Name": "site_slug",
@@ -174,20 +188,27 @@
               "Type": "string",
               "Description": "the site holding the blog"
             },
+            {
+              "Name": "blog_id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "the ID of the blog"
+            },
             {
               "Name": "body",
               "Required": "Y",
               "Default": "1",
               "Type": "json",
-              "Description": "a JSON representation of the new blog"
+              "Description": "a JSON representation of the new post"
             }
           ]
         },
         {
           "MethodName": "Update",
-          "Synopsis": "Updates the attributes of a blog",
+          "Synopsis": "Updates the attributes of a blog post",
           "HTTPMethod": "PUT",
-          "URI": "/sites/:site_slug/pages/blogs/:id",
+          "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id",
           "parameters": [
             {
               "Name": "site_slug",
@@ -197,7 +218,14 @@
               "Description": "the site holding the blog"
             },
             {
-              "Name": "id",
+              "Name": "blog_id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "the ID of the blog"
+            },
+            {
+              "Name": "blog_post_id",
               "Required": "Y",
               "Default": null,
               "Type": "int",
@@ -214,9 +242,9 @@
         },
         {
           "MethodName": "Destroy",
-          "Synopsis": "Removes a blog",
+          "Synopsis": "Removes a blog post",
           "HTTPMethod": "DELETE",
-          "URI": "/sites/:site_slug/pages/blogs/:id",
+          "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id",
           "parameters": [
             {
               "Name": "site_slug",
@@ -226,7 +254,14 @@
               "Description": "the site holding the blog"
             },
             {
-              "Name": "id",
+              "Name": "blog_id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "the ID of the blog"
+            },
+            {
+              "Name": "blog_post_id",
               "Required": "Y",
               "Default": null,
               "Type": "int",
@@ -237,13 +272,13 @@
       ]
     },
     {
-      "name": "Blog Posts",
+      "name": "Blogs",
       "methods": [
         {
           "MethodName": "Index",
-          "Synopsis": "Shows a list of blog's posts",
+          "Synopsis": "Shows a list of all blogs",
           "HTTPMethod": "GET",
-          "URI": "/sites/:site_slug/pages/blogs/:id/posts",
+          "URI": "/sites/:site_slug/pages/blogs",
           "parameters": [
             {
               "Name": "site_slug",
@@ -252,13 +287,6 @@
               "Type": "string",
               "Description": "the site holding the blog"
             },
-            {
-              "Name": "id",
-              "Required": "Y",
-              "Default": null,
-              "Type": "int",
-              "Description": "the ID of the blog"
-            },
             {
               "Name": "page",
               "Required": "N",
@@ -276,10 +304,10 @@
           ]
         },
         {
-          "MethodName": "Match",
-          "Synopsis": "Find a blog post by its external id",
+          "MethodName": "Show",
+          "Synopsis": "Show the details of a blog",
           "HTTPMethod": "GET",
-          "URI": "/sites/:site_slug/pages/blogs/:id/match",
+          "URI": "/sites/:site_slug/pages/blogs/:id",
           "parameters": [
             {
               "Name": "site_slug",
@@ -294,21 +322,14 @@
               "Default": null,
               "Type": "int",
               "Description": "the ID of the blog"
-            },
-            {
-              "Name": "external_id",
-              "Required": "N",
-              "Default": "1",
-              "Type": "int",
-              "Description": "the external id of the post"
             }
           ]
         },
         {
           "MethodName": "Create",
-          "Synopsis": "Creates a new blog post",
+          "Synopsis": "Creates a new blog",
           "HTTPMethod": "POST",
-          "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts",
+          "URI": "/sites/:site_slug/pages/blogs",
           "parameters": [
             {
               "Name": "site_slug",
@@ -317,27 +338,20 @@
               "Type": "string",
               "Description": "the site holding the blog"
             },
-            {
-              "Name": "blog_id",
-              "Required": "Y",
-              "Default": null,
-              "Type": "int",
-              "Description": "the ID of the blog"
-            },
             {
               "Name": "body",
               "Required": "Y",
               "Default": "1",
               "Type": "json",
-              "Description": "a JSON representation of the new post"
+              "Description": "a JSON representation of the new blog"
             }
           ]
         },
         {
           "MethodName": "Update",
-          "Synopsis": "Updates the attributes of a blog post",
+          "Synopsis": "Updates the attributes of a blog",
           "HTTPMethod": "PUT",
-          "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id",
+          "URI": "/sites/:site_slug/pages/blogs/:id",
           "parameters": [
             {
               "Name": "site_slug",
@@ -347,14 +361,7 @@
               "Description": "the site holding the blog"
             },
             {
-              "Name": "blog_id",
-              "Required": "Y",
-              "Default": null,
-              "Type": "int",
-              "Description": "the ID of the blog"
-            },
-            {
-              "Name": "blog_post_id",
+              "Name": "id",
               "Required": "Y",
               "Default": null,
               "Type": "int",
@@ -371,9 +378,9 @@
         },
         {
           "MethodName": "Destroy",
-          "Synopsis": "Removes a blog post",
+          "Synopsis": "Removes a blog",
           "HTTPMethod": "DELETE",
-          "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id",
+          "URI": "/sites/:site_slug/pages/blogs/:id",
           "parameters": [
             {
               "Name": "site_slug",
@@ -383,14 +390,7 @@
               "Description": "the site holding the blog"
             },
             {
-              "Name": "blog_id",
-              "Required": "Y",
-              "Default": null,
-              "Type": "int",
-              "Description": "the ID of the blog"
-            },
-            {
-              "Name": "blog_post_id",
+              "Name": "id",
               "Required": "Y",
               "Default": null,
               "Type": "int",
@@ -1271,6 +1271,106 @@
         }
       ]
     },
+    {
+      "name": "Memberships",
+      "methods": [
+        {
+          "MethodName": "Index",
+          "Synopsis": "Lists all memberships for a person",
+          "HTTPMethod": "GET",
+          "URI": "/people/:person_id/memberships",
+          "parameters": [
+            {
+              "Name": "person_id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "The person's ID"
+            },
+            {
+              "Name": "page",
+              "Required": "N",
+              "Default": "1",
+              "Type": "int",
+              "Description": "Which page to return"
+            },
+            {
+              "Name": "per_page",
+              "Required": "N",
+              "Default": "10",
+              "Type": "int",
+              "Description": "The number of listings to return per page"
+            }
+          ]
+        },
+        {
+          "MethodName": "Create",
+          "Synopsis": "Creates a membership",
+          "HTTPMethod": "POST",
+          "URI": "/people/:person_id/memberships",
+          "parameters": [
+            {
+              "Name": "person_id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "The person's ID"
+            },
+            {
+              "Name": "body",
+              "Required": "Y",
+              "Default": "{}",
+              "Type": "json",
+              "Description": "JSON attributes for the new membership"
+            }
+          ]
+        },
+        {
+          "MethodName": "Update",
+          "Synopsis": "Updates a membership",
+          "HTTPMethod": "PUT",
+          "URI": "/people/:person_id/memberships",
+          "parameters": [
+            {
+              "Name": "person_id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "The person's ID"
+            },
+            {
+              "Name": "body",
+              "Required": "Y",
+              "Default": "{}",
+              "Type": "json",
+              "Description": "JSON attributes for updating a membership"
+            }
+          ]
+        },
+        {
+          "MethodName": "Destroy",
+          "Synopsis": "Removes a membership from the person",
+          "HTTPMethod": "DELETE",
+          "URI": "/people/:person_id/memberships/:name",
+          "parameters": [
+            {
+              "Name": "person_id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "The person's ID"
+            },
+            {
+              "Name": "name",
+              "Required": "Y",
+              "Default": null,
+              "Type": "string",
+              "Description": "The name of the membership"
+            }
+          ]
+        }
+      ]
+    },
     {
       "name": "Page Attachments",
       "methods": [
@@ -1911,6 +2011,69 @@
         }
       ]
     },
+    {
+      "name": "Survey Responses",
+      "methods": [
+        {
+          "MethodName": "Index",
+          "Synopsis": "Lists all survey responses",
+          "HTTPMethod": "GET",
+          "URI": "/survey_responses",
+          "parameters": [
+            {
+              "Name": "start_time",
+              "Required": "N",
+              "Default": null,
+              "Type": "string",
+              "Description": "the starting time for results"
+            },
+            {
+              "Name": "end_time",
+              "Required": "N",
+              "Default": null,
+              "Type": "string",
+              "Description": "the ending time for results"
+            },
+            {
+              "Name": "survey_id",
+              "Required": "N",
+              "Default": null,
+              "Type": "int",
+              "Description": "the id for a parent survey"
+            },
+            {
+              "Name": "page",
+              "Required": "N",
+              "Default": "1",
+              "Type": "int",
+              "Description": "result page number"
+            },
+            {
+              "Name": "per_page",
+              "Required": "N",
+              "Default": "10",
+              "Type": "int",
+              "Description": "number of results to return"
+            }
+          ]
+        },
+        {
+          "MethodName": "Create",
+          "Synopsis": "Creates responses for a survey",
+          "HTTPMethod": "POST",
+          "URI": "/survey_responses",
+          "parameters": [
+            {
+              "Name": "body",
+              "Required": "Y",
+              "Default": null,
+              "Type": "json",
+              "Description": "a JSON representation of the survey responses"
+            }
+          ]
+        }
+      ]
+    },
     {
       "name": "Surveys",
       "methods": [
@@ -2018,69 +2181,6 @@
         }
       ]
     },
-    {
-      "name": "Survey Responses",
-      "methods": [
-        {
-          "MethodName": "Index",
-          "Synopsis": "Lists all survey responses",
-          "HTTPMethod": "GET",
-          "URI": "/survey_responses",
-          "parameters": [
-            {
-              "Name": "start_time",
-              "Required": "N",
-              "Default": null,
-              "Type": "string",
-              "Description": "the starting time for results"
-            },
-            {
-              "Name": "end_time",
-              "Required": "N",
-              "Default": null,
-              "Type": "string",
-              "Description": "the ending time for results"
-            },
-            {
-              "Name": "survey_id",
-              "Required": "N",
-              "Default": null,
-              "Type": "int",
-              "Description": "the id for a parent survey"
-            },
-            {
-              "Name": "page",
-              "Required": "N",
-              "Default": "1",
-              "Type": "int",
-              "Description": "result page number"
-            },
-            {
-              "Name": "per_page",
-              "Required": "N",
-              "Default": "10",
-              "Type": "int",
-              "Description": "number of results to return"
-            }
-          ]
-        },
-        {
-          "MethodName": "Create",
-          "Synopsis": "Creates responses for a survey",
-          "HTTPMethod": "POST",
-          "URI": "/survey_responses",
-          "parameters": [
-            {
-              "Name": "body",
-              "Required": "Y",
-              "Default": null,
-              "Type": "json",
-              "Description": "a JSON representation of the survey responses"
-            }
-          ]
-        }
-      ]
-    },
     {
       "name": "Webhooks",
       "methods": [

data/lib/nationbuilder/client.rb

@@ -101,9 +101,9 @@ class NationBuilder::Client
     self[endpoint_name].methods.each do |method_name|
       puts
       method = self[endpoint_name][method_name]
-      puts "  Method: #{method_name.inspect}"
+      puts "  Method: #{method_name}"
       puts "  Description: #{method.description}"
-      required_params = method.parameters.map { |p| p.inspect }
+      required_params = method.parameters.map { |p| p }
       if required_params.any?
         puts "  Required parameters: #{required_params.join(', ')}"
       end

data/nationbuilder-rb.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: nationbuilder-rb 0.0.3 ruby lib
+# stub: nationbuilder-rb 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "nationbuilder-rb"
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["David Huie"]
-  s.date = "2014-07-05"
+  s.date = "2014-07-29"
   s.description = "A Ruby client to the NationBuilder API"
   s.email = "david@nationbuilder.com"
   s.executables = ["nbdoc"]

data/spec/nationbuilder_client_spec.rb

@@ -12,12 +12,12 @@ describe NationBuilder::Client do
   describe '#endpoints' do
 
     it 'should contain all defined endpoints' do
-      client.endpoints.should eq([:basic_pages, :blogs, :blog_posts,
+      client.endpoints.should eq([:basic_pages, :blog_posts, :blogs,
                                    :calendars, :campaign_data, :contacts,
                                    :contact_types, :donations, :events,
-                                   :imports, :lists, :page_attachments,
-                                   :people, :people_tags, :sites, :surveys,
-                                   :survey_responses, :webhooks])
+                                   :imports, :lists, :memberships, :page_attachments,
+                                   :people, :people_tags, :sites,
+                                   :survey_responses, :surveys, :webhooks])
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nationbuilder-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - David Huie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-05 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient