nationbuilder-rb 1.3.5 → 1.3.6

data/lib/api_spec/lib/api_spec/specs/events.rb

@@ -3,9 +3,9 @@ class ApiSpec::Spec
   endpoint 'Events' do |event|
 
     event.method('Index') do |method|
-      method.synopsis = "Returns a list of events"
-      method.http_method = "GET"
-      method.uri = "/sites/:site_slug/pages/events"
+      method.synopsis = 'Returns a list of events'
+      method.http_method = 'GET'
+      method.uri = '/sites/:site_slug/pages/events'
 
       method.parameter('site_slug') do |p|
         p.required = 'Y'
@@ -55,13 +55,12 @@ class ApiSpec::Spec
         p.type = 'int'
         p.description = 'the ID of the calendar from which events should be scoped'
       end
-
     end
 
     event.method('Show') do |method|
-      method.synopsis = "Returns an event"
-      method.http_method = "GET"
-      method.uri = "/sites/:site_slug/pages/events/:id"
+      method.synopsis = 'Returns an event'
+      method.http_method = 'GET'
+      method.uri = '/sites/:site_slug/pages/events/:id'
 
       method.parameter('site_slug') do |p|
         p.required = 'Y'
@@ -72,15 +71,14 @@ class ApiSpec::Spec
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'the ID of the event'
+        p.description = "the event's ID"
       end
-
     end
 
     event.method('Create') do |method|
-      method.synopsis = "Creates a event with the provided data"
-      method.http_method = "POST"
-      method.uri = "/sites/:site_slug/pages/events"
+      method.synopsis = 'Creates a event with the provided data'
+      method.http_method = 'POST'
+      method.uri = '/sites/:site_slug/pages/events'
 
       method.parameter('site_slug') do |p|
         p.required = 'Y'
@@ -97,9 +95,9 @@ class ApiSpec::Spec
     end
 
     event.method('Update') do |method|
-      method.synopsis = "Updates a event with the provided data"
-      method.http_method = "PUT"
-      method.uri = "/sites/:site_slug/pages/events/:id"
+      method.synopsis = 'Updates a event with the provided data'
+      method.http_method = 'PUT'
+      method.uri = '/sites/:site_slug/pages/events/:id'
 
       method.parameter('site_slug') do |p|
         p.required = 'Y'
@@ -110,7 +108,7 @@ class ApiSpec::Spec
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The event's ID"
+        p.description = "the event's ID"
       end
 
       method.parameter('body') do |p|
@@ -122,9 +120,9 @@ class ApiSpec::Spec
     end
 
     event.method('Destroy') do |method|
-      method.synopsis = "Removes the event with the matching ID"
-      method.http_method = "DELETE"
-      method.uri = "/sites/:site_slug/pages/events/:id"
+      method.synopsis = 'Removes the event with the matching ID'
+      method.http_method = 'DELETE'
+      method.uri = '/sites/:site_slug/pages/events/:id'
 
       method.parameter('site_slug') do |p|
         p.required = 'Y'
@@ -135,14 +133,14 @@ class ApiSpec::Spec
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The event's ID"
+        p.description = "the event's ID"
       end
     end
 
     event.method('RSVPs') do |method|
-      method.synopsis = "Lists all RSVPs for an event"
-      method.http_method = "GET"
-      method.uri = "/sites/:site_slug/pages/events/:id/rsvps"
+      method.synopsis = 'Lists all RSVPs for an event'
+      method.http_method = 'GET'
+      method.uri = '/sites/:site_slug/pages/events/:id/rsvps'
 
       method.parameter('site_slug') do |p|
         p.required = 'Y'
@@ -153,7 +151,7 @@ class ApiSpec::Spec
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The event's ID"
+        p.description = "the event's ID"
       end
 
       method.parameter('__token') do |p|
@@ -174,13 +172,12 @@ class ApiSpec::Spec
         p.type = 'int'
         p.description = 'maximum number of results to return'
       end
-
     end
 
     event.method('RSVP Create') do |method|
-      method.synopsis = "Creates an RSVP for an event"
-      method.http_method = "POST"
-      method.uri = "/sites/:site_slug/pages/events/:id/rsvps"
+      method.synopsis = 'Creates an RSVP for an event'
+      method.http_method = 'POST'
+      method.uri = '/sites/:site_slug/pages/events/:id/rsvps'
 
       method.parameter('site_slug') do |p|
         p.required = 'Y'
@@ -191,7 +188,7 @@ class ApiSpec::Spec
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The event's ID"
+        p.description = "the event's ID"
       end
 
       method.parameter('body') do |p|
@@ -199,13 +196,12 @@ class ApiSpec::Spec
         p.type = 'json'
         p.description = 'A JSON representation of the new post'
       end
-
     end
 
     event.method('RSVP Update') do |method|
-      method.synopsis = "Updates an existing RSVP"
-      method.http_method = "PUT"
-      method.uri = "/sites/:site_slug/pages/events/:event_id/rsvps/:rsvp_id"
+      method.synopsis = 'Updates an existing RSVP'
+      method.http_method = 'PUT'
+      method.uri = '/sites/:site_slug/pages/events/:event_id/rsvps/:rsvp_id'
 
       method.parameter('site_slug') do |p|
         p.required = 'Y'
@@ -216,13 +212,13 @@ class ApiSpec::Spec
       method.parameter('event_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The event's ID"
+        p.description = "the event's ID"
       end
 
       method.parameter('rsvp_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The RSVP's ID"
+        p.description = "the RSVP's ID"
       end
 
       method.parameter('body') do |p|
@@ -230,9 +226,6 @@ class ApiSpec::Spec
         p.type = 'json'
         p.description = 'JSON attributes for updating the RSVP'
       end
-
     end
-
   end
-
 end

data/lib/api_spec/lib/api_spec/specs/exports.rb

@@ -2,10 +2,16 @@ class ApiSpec::Spec
 
   endpoint 'Exports' do |export|
 
-    export.method('Create List') do |method|
-      method.synopsis = "Creates a list export with the provided data"
-      method.http_method = "POST"
-      method.uri = "/list/:list_id/exports"
+    export.method('Export List') do |method|
+      method.synopsis = 'Starts an export of a list'
+      method.http_method = 'POST'
+      method.uri = '/lists/:list_id/exports'
+
+      method.parameter('list_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'ID of the list to export'
+      end
 
       method.parameter('body') do |p|
         p.required = 'Y'
@@ -15,9 +21,9 @@ class ApiSpec::Spec
     end
 
     export.method('Show') do |method|
-      method.synopsis = "Shows the status of a list export."
-      method.http_method = "GET"
-      method.uri = "/exports/:id"
+      method.synopsis = 'Shows the status of a list export.'
+      method.http_method = 'GET'
+      method.uri = '/exports/:id'
 
       method.parameter('id') do |p|
         p.required = 'Y'
@@ -27,9 +33,9 @@ class ApiSpec::Spec
     end
 
     export.method('Delete') do |method|
-      method.synopsis = "Delete the export"
-      method.http_method = "DELETE"
-      method.uri = "/exports/:id"
+      method.synopsis = 'Delete the export'
+      method.http_method = 'DELETE'
+      method.uri = '/exports/:id'
 
       method.parameter('id') do |p|
         p.required = 'Y'
@@ -38,5 +44,4 @@ class ApiSpec::Spec
       end
     end
   end
-
 end

data/lib/api_spec/lib/api_spec/specs/imports.rb

@@ -3,22 +3,21 @@ class ApiSpec::Spec
   endpoint 'Imports' do |import|
 
     import.method('Show') do |method|
-      method.synopsis = "Shows the status of an import"
-      method.http_method = "GET"
-      method.uri = "/imports/:id"
+      method.synopsis = 'Shows the status of an import'
+      method.http_method = 'GET'
+      method.uri = '/imports/:id'
 
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
         p.description = 'the ID of the import'
       end
-
     end
 
     import.method('Create') do |method|
-      method.synopsis = "Creates a import with the provided data"
-      method.http_method = "POST"
-      method.uri = "/imports"
+      method.synopsis = 'Creates a import with the provided data'
+      method.http_method = 'POST'
+      method.uri = '/imports'
 
       method.parameter('body') do |p|
         p.required = 'Y'
@@ -28,9 +27,9 @@ class ApiSpec::Spec
     end
 
     import.method('Result') do |method|
-      method.synopsis = "Gets the import results and error csv file."
-      method.http_method = "GET"
-      method.uri = "/imports/:id/result"
+      method.synopsis = 'Gets the import results and error csv file.'
+      method.http_method = 'GET'
+      method.uri = '/imports/:id/result'
 
       method.parameter('id') do |p|
         p.required = 'Y'
@@ -39,5 +38,4 @@ class ApiSpec::Spec
       end
     end
   end
-
 end

data/lib/api_spec/lib/api_spec/specs/lists.rb

@@ -3,9 +3,9 @@ class ApiSpec::Spec
   endpoint 'Lists' do |lists|
 
     lists.method('Index') do |method|
-      method.synopsis = "Returns a list of created custom lists"
-      method.http_method = "GET"
-      method.uri = "/lists"
+      method.synopsis = 'Returns a list of created custom lists'
+      method.http_method = 'GET'
+      method.uri = '/lists'
 
       method.parameter('__token') do |p|
         p.required = 'N'
@@ -28,14 +28,14 @@ class ApiSpec::Spec
     end
 
     lists.method('People') do |method|
-      method.synopsis = "Returns people stored in a list"
-      method.http_method = "GET"
-      method.uri = "/lists/:id/people"
+      method.synopsis = 'Returns people stored in a list'
+      method.http_method = 'GET'
+      method.uri = '/lists/:id/people'
 
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The list's ID"
+        p.description = "the list's ID"
       end
 
       method.parameter('__token') do |p|
@@ -59,27 +59,27 @@ class ApiSpec::Spec
     end
 
     lists.method('Create') do |method|
-      method.synopsis = "Creates a list with the provided data"
-      method.http_method = "POST"
-      method.uri = "/lists"
+      method.synopsis = 'Creates a list with the provided data'
+      method.http_method = 'POST'
+      method.uri = '/lists'
 
       method.parameter('body') do |p|
         p.required = 'Y'
         p.default = '{}'
         p.type = 'json'
-        p.description = 'JSON representation of the list to create'
+        p.description = 'a JSON representation of the list to create'
       end
     end
 
     lists.method('Update') do |method|
-      method.synopsis = "Updates a list with the provided data"
-      method.http_method = "PUT"
-      method.uri = "/lists/:id"
+      method.synopsis = 'Updates a list with the provided data'
+      method.http_method = 'PUT'
+      method.uri = '/lists/:id'
 
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The list's ID"
+        p.description = "the list's ID"
       end
 
       method.parameter('body') do |p|
@@ -91,26 +91,26 @@ class ApiSpec::Spec
     end
 
     lists.method('Destroy') do |method|
-      method.synopsis = "Removes the list with the matching ID"
-      method.http_method = "DELETE"
-      method.uri = "/lists/:id"
+      method.synopsis = 'Removes the list with the matching ID'
+      method.http_method = 'DELETE'
+      method.uri = '/lists/:id'
 
       method.parameter('id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = "The list's ID"
+        p.description = "the list's ID"
       end
     end
 
     lists.method('Add people') do |method|
-      method.synopsis = "Adds people to a list"
-      method.http_method = "POST"
-      method.uri = "/lists/:list_id/people"
+      method.synopsis = 'Adds people to a list'
+      method.http_method = 'POST'
+      method.uri = '/lists/:list_id/people'
 
       method.parameter('list_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The ID of the list'
+        p.description = "the list's ID"
       end
 
       method.parameter('body') do |p|
@@ -121,14 +121,14 @@ class ApiSpec::Spec
     end
 
     lists.method('Destroy people') do |method|
-      method.synopsis = "Removes people from a list"
-      method.http_method = "DELETE"
-      method.uri = "/lists/:list_id/people"
+      method.synopsis = 'Removes people from a list'
+      method.http_method = 'DELETE'
+      method.uri = '/lists/:list_id/people'
 
       method.parameter('list_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The ID of the list'
+        p.description = "the list's ID"
       end
 
       method.parameter('body') do |p|
@@ -139,77 +139,75 @@ class ApiSpec::Spec
     end
 
     lists.method('Listing Create (deprecated)') do |method|
-      method.synopsis = "Adds a person to a list"
-      method.http_method = "POST"
-      method.uri = "/lists/:list_id/listings"
+      method.synopsis = 'Adds a person to a list'
+      method.http_method = 'POST'
+      method.uri = '/lists/:list_id/listings'
 
       method.parameter('list_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The ID of the list'
+        p.description = "the list's ID"
       end
 
       method.parameter('person_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The ID of the person to add to the list'
+        p.description = 'the ID of the person to add to the list'
       end
     end
 
     lists.method('Listing Deletion (deprecated)') do |method|
-      method.synopsis = "Drops a person from a list"
-      method.http_method = "DELETE"
-      method.uri = "/lists/:list_id/listings/:person_id"
+      method.synopsis = 'Drops a person from a list'
+      method.http_method = 'DELETE'
+      method.uri = '/lists/:list_id/listings/:person_id'
 
       method.parameter('list_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The ID of the list'
+        p.description = "the list's ID"
       end
 
       method.parameter('person_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The ID of the person to drop from the list'
+        p.description = 'the ID of the person to drop from the list'
       end
     end
 
     lists.method('Add tag') do |method|
-      method.synopsis = "Adds a tag to all of the list members"
-      method.http_method = "POST"
-      method.uri = "/lists/:list_id/tag/:tag"
+      method.synopsis = 'Adds a tag to all of the list members'
+      method.http_method = 'POST'
+      method.uri = '/lists/:list_id/tag/:tag'
 
       method.parameter('list_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The ID of the list'
+        p.description = "the list's ID"
       end
 
       method.parameter('tag') do |p|
         p.required = 'Y'
         p.type = 'string'
-        p.description = 'The name of the tag to use'
+        p.description = 'the name of the tag to use'
       end
     end
 
     lists.method('Delete tag') do |method|
-      method.synopsis = "Deletes the tag from all of the list members"
-      method.http_method = "DELETE"
-      method.uri = "/lists/:list_id/tag/:tag"
+      method.synopsis = 'Deletes the tag from all of the list members'
+      method.http_method = 'DELETE'
+      method.uri = '/lists/:list_id/tag/:tag'
 
       method.parameter('list_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The ID of the list'
+        p.description = "the list's ID"
       end
 
       method.parameter('tag') do |p|
         p.required = 'Y'
         p.type = 'string'
-        p.description = 'The name of the tag to use'
+        p.description = 'the name of the tag to use'
       end
     end
-
   end
-
 end

data/lib/api_spec/lib/api_spec/specs/memberships.rb

@@ -1,7 +1,7 @@
 class ApiSpec::Spec
 
   endpoint 'Memberships' do |memberships|
-
+    
     memberships.method('Index') do |method|
       method.synopsis = 'Lists all memberships for a person'
       method.http_method = 'GET'
@@ -10,7 +10,7 @@ class ApiSpec::Spec
       method.parameter('person_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The person\'s ID'
+        p.description = "the person's ID"
       end
 
       method.parameter('__token') do |p|
@@ -41,7 +41,7 @@ class ApiSpec::Spec
       method.parameter('person_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The person\'s ID'
+        p.description = "the person's ID"
       end
 
       method.parameter('body') do |p|
@@ -60,7 +60,7 @@ class ApiSpec::Spec
       method.parameter('person_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The person\'s ID'
+        p.description = "the person's ID"
       end
 
       method.parameter('body') do |p|
@@ -79,16 +79,14 @@ class ApiSpec::Spec
       method.parameter('person_id') do |p|
         p.required = 'Y'
         p.type = 'int'
-        p.description = 'The person\'s ID'
+        p.description = "the person's ID"
       end
 
       method.parameter('name') do |p|
         p.required = 'Y'
         p.type = 'string'
-        p.description = 'The name of the membership'
+        p.description = 'the name of the membership'
       end
     end
-
   end
-
 end