nationbuilder-rb 1.3.2 → 1.3.3

data/lib/api_spec/lib/api_spec/specs/blogs.rb

@@ -0,0 +1,128 @@
+class ApiSpec::Spec
+
+  endpoint 'Blogs' do |bp|
+
+    bp.method('Index') do |m|
+
+      m.synopsis = "Shows a list of all blogs"
+      m.http_method = "GET"
+      m.uri = "/sites/:site_slug/pages/blogs"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding 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('Show') do |m|
+
+      m.synopsis = "Show the details of a blog"
+      m.http_method = "GET"
+      m.uri = "/sites/:site_slug/pages/blogs/:id"
+
+      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
+
+    end
+
+    bp.method('Create') do |m|
+
+      m.synopsis = "Creates a new blog"
+      m.http_method = "POST"
+      m.uri = "/sites/:site_slug/pages/blogs"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding 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 blog'
+      end
+
+    end
+
+    bp.method('Update') do |m|
+
+      m.synopsis = "Updates the attributes of a blog"
+      m.http_method = "PUT"
+      m.uri = "/sites/:site_slug/pages/blogs/:id"
+
+      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('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"
+      m.http_method = "DELETE"
+      m.uri = "/sites/:site_slug/pages/blogs/:id"
+
+      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
+
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/calendars.rb

@@ -0,0 +1,128 @@
+class ApiSpec::Spec
+
+  endpoint 'Calendars' do |bp|
+
+    bp.method('Index') do |m|
+
+      m.synopsis = "Shows a list of calendars"
+      m.http_method = "GET"
+      m.uri = "/sites/:site_slug/pages/calendars"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the calendars'
+      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('Show') do |m|
+
+      m.synopsis = "Show the details of a calendar"
+      m.http_method = "GET"
+      m.uri = "/sites/:site_slug/pages/calendars/:id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the calendar'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the calendar'
+      end
+
+    end
+
+    bp.method('Create') do |m|
+
+      m.synopsis = "Creates a new calendar"
+      m.http_method = "POST"
+      m.uri = "/sites/:site_slug/pages/calendars"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the calendar'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '1'
+        p.type = 'json'
+        p.description = 'a JSON representation of the new calendar'
+      end
+
+    end
+
+    bp.method('Update') do |m|
+
+      m.synopsis = "Updates the attributes of a calendar"
+      m.http_method = "PUT"
+      m.uri = "/sites/:site_slug/pages/calendars/:id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the calendar'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the calendar'
+      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 calendar"
+      m.http_method = "DELETE"
+      m.uri = "/sites/:site_slug/pages/calendars/:id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the calendar'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the calendar'
+      end
+
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/campaign_data.rb

@@ -0,0 +1,15 @@
+class ApiSpec::Spec
+
+  endpoint 'Campaign Data' do |bp|
+
+    bp.method('Show') do |m|
+
+      m.synopsis = "Shows campaign metadata about the nation"
+      m.http_method = "GET"
+      m.uri = "/campaign_data"
+
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/contacts.rb

@@ -0,0 +1,155 @@
+class ApiSpec::Spec
+
+  endpoint 'Contacts' do |c|
+
+    c.method('Index') do |m|
+
+      m.synopsis = "View a paginated list of a person's contacts"
+      m.http_method = "GET"
+      m.uri = "/people/:person_id/contacts"
+
+      m.parameter('person_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the person\'s ID'
+      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
+
+    c.method('Create') do |m|
+
+      m.synopsis = "Record a contact for a person"
+      m.http_method = "POST"
+      m.uri = "/people/:person_id/contacts"
+
+      m.parameter('person_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the person\'s ID'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'a JSON representation of the new contact'
+      end
+
+    end
+
+  end
+
+  endpoint 'Contact Types' do |c|
+
+    c.method('Index') do |m|
+
+      m.synopsis = "Returns paginated list of nation-defined contact types"
+      m.http_method = "GET"
+      m.uri = "/settings/contact_types"
+
+      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
+
+    c.method('Create') do |m|
+
+      m.synopsis = "Creates a new contact type"
+      m.http_method = "POST"
+      m.uri = "/settings/contact_types"
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'a JSON representation of the new contact type'
+      end
+
+    end
+
+    c.method('Update') do |m|
+
+      m.synopsis = "Updates an existing contact type"
+      m.http_method = "PUT"
+      m.uri = "/settings/contact_types/:id"
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the existing contact type'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'a JSON representation of the updates to make'
+      end
+
+    end
+
+    c.method('Destroy') do |m|
+
+      m.synopsis = "Destroys a contact type"
+      m.http_method = "DELETE"
+      m.uri = "/settings/contact_types/:id"
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the existing contact type'
+      end
+
+    end
+
+    c.method('List Methods') do |m|
+
+      m.synopsis = "Lists all contact methods"
+      m.http_method = "GET"
+      m.uri = "/settings/contact_methods"
+
+    end
+
+    c.method('List Statuses') do |m|
+
+      m.synopsis = "Lists all contact status types"
+      m.http_method = "GET"
+      m.uri = "/settings/contact_statuses"
+
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/donations.rb

@@ -0,0 +1,76 @@
+class ApiSpec::Spec
+
+  endpoint 'Donations' do |donation|
+
+    donation.method('Index') do |method|
+      method.synopsis = "Returns a list of donations"
+      method.http_method = "GET"
+      method.uri = "/donations"
+
+      method.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      method.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      method.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+    end
+
+    donation.method('Create') do |method|
+      method.synopsis = "Creates a donation with the provided data"
+      method.http_method = "POST"
+      method.uri = "/donations"
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '{}'
+        p.type = 'json'
+        p.description = 'JSON representation of a donation'
+      end
+    end
+
+    donation.method('Update') do |method|
+      method.synopsis = "Updates a donation with the provided data"
+      method.http_method = "PUT"
+      method.uri = "/donations/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The donation's ID"
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '{}'
+        p.type = 'json'
+        p.description = 'JSON attributes for updating the donation'
+      end
+    end
+
+    donation.method('Destroy') do |method|
+      method.synopsis = "Removes the donation with the matching ID"
+      method.http_method = "DELETE"
+      method.uri = "/donations/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The donation's ID"
+      end
+    end
+
+  end
+
+end