actionkit_connector 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e8ac5ca62b2bc490f252ac6fe28e779186420dd
-  data.tar.gz: 023b208b610f7b71e07f0fde4fa64a9156615d63
+  metadata.gz: 51bad1dd8382c738ff52aeee2276b6fbc5136ae7
+  data.tar.gz: 80db19e48df8f18c9ff5cc9e52011f5ae32244ce
 SHA512:
-  metadata.gz: adf985e88a49a3726333e3f50d5e1c639ce845bd453c37c979897a5347b0c818b668ae4820a20265df2e954a55ae8c8a0e82d2112a0cede3cac5a9cb5d47ecf9
-  data.tar.gz: 62399a6c565264f3bd7c8b7e1e9260c1afb6bd5983e1b198bde942fb585da241cb653134ec62b589b40e7ba2fbb8fb51b2a0e8b2929fb327b4149c0194722f2f
+  metadata.gz: ac037266a94ae054753a6ce1373202d23b1c99852b0bcb9f6cea8df686cdc4ede718c9376f52f4f186a996bda916cbf0c94c0f1e9e917d9e9d1cc572424e21bd
+  data.tar.gz: 6f9a8ce758a7a4b3e1d4c88eaaf5380ca3c68f78b5f3c0c6417a69b53d44a6f0534cc4c489e82376473b0924e7af2adcaa3dcef47b12e5171f36cdf690018f8e

data/.gitignore

@@ -14,3 +14,4 @@
 mkmf.log
 .idea/
 *.iml
+local_test.rb

data/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in actionkit_connector.gemspec
 gemspec
 gem 'httparty', '~> 0.13'
+gem 'rspec'

data/actionkit_connector.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
 end

data/lib/actionkit_connector.rb

@@ -1,18 +1,39 @@
-require "actionkit_connector/version"
+require_relative 'actionkit_connector/version'
+require 'httparty'
 
 module ActionKitConnector
   class Connector
     include HTTParty
 
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :base_url
+
+    # Initializes a connector to the ActionKit API.
+    # A new connection is created on each call, so there
+    # no need to worry about resource utilization.
+    #
+    # @param [String] username The username of your ActionKit user.
+    # @param [String] password The password for your ActionKit user.
+    # @param [String] base_url The base url of your ActionKit instance.
     def initialize(username, password, base_url)
-      @auth = {username: username, password: password}
-      @base_url = base_url
+      self.username = username
+      self.password = password
+      self.base_url = base_url
+    end
+
+    def auth
+      {username: self.username, password: self.password}
     end
 
+    # Lists petition pages in your instance.
+    #
+    # @param [Int] offset The number of records to skip.
+    # @param [Int] limit  The maximum number of results to return.
     def list_petition_pages(offset=0, limit=20)
-      target = "#{@base_url}/petitionpage/"
+      target = "#{self.base_url}/petitionpage/"
       options = {
-          basic_auth: @auth,
+          basic_auth: self.auth,
           query: {
               _limit: limit,
               _offset: offset
@@ -21,20 +42,55 @@ module ActionKitConnector
       self.class.get(target, options)
     end
 
+    # Returns the information for a single PetitionPage.
+    #
+    # @param [Int] id The ID of the page to return.
     def petition_page(id)
-      target = "#{@base_url}/petitionpage/#{id}/"
-      self.class.get(target, {basic_auth: @auth})
+      target = "#{self.base_url}/petitionpage/#{id}/"
+      self.class.get(target, {basic_auth: self.auth})
     end
 
+    # Create a petition page in your ActionKit instance.
+    #
+    # @param [String] name          The name of the page.
+    # @param [String] title         The title of the page.
+    # @param [URI]    lang          The URI string for the language of this page in the form of /rest/v1/language/{id}
+    # @param [URL]    canonical_url The canonical URL for this page.
     def create_petition_page(name, title, lang, canonical_url)
-      target = "#{@base_url}/petitionpage/"
+      target = "#{self.base_url}/petitionpage/"
+      options = {
+          basic_auth: self.auth,
+          headers: {
+              'Content-type' => 'application/json'
+          },
+          :body => {
+              :type => 'petitionpage',
+              :hidden => false,
+              :name => name,
+              :title => title,
+              :lang => lang,
+              :canonical_url => canonical_url
+          }.to_json,
+          format: :json
+      }
+      self.class.post(target, options)
+    end
+
+    # Create a donation page in your ActionKit instance.
+    #
+    # @param [String] name          The name of the page.
+    # @param [String] title         The title of the page.
+    # @param [URI]    lang          The URI string for the language of this page in the form of /rest/v1/language/{id}
+    # @param [URL]    canonical_url The canonical URL for this page.
+    def create_donation_page(name, title, lang, canonical_url)
+      target = "#{self.base_url}/donationpage/"
       options = {
-          basic_auth: @auth,
+          basic_auth: self.auth,
           headers: {
               'Content-type' => 'application/json'
           },
           :body => {
-              :type => "petitionpage",
+              :type => 'donationpage',
               :hidden => false,
               :name => name,
               :title => title,
@@ -46,10 +102,14 @@ module ActionKitConnector
       self.class.post(target, options)
     end
 
+    # Creates an action which associates a user with a page.
+    #
+    # @param [String] page_name The ActionKit name of the page on which the action is being taken.
+    # @param [String] email     The email address of the person taking action.
     def create_action(page_name, email)
-      target = "#{@base_url}/action/"
+      target = "#{self.base_url}/action/"
       options = {
-          basic_auth: @auth,
+          basic_auth: self.auth,
           body: {
               page: page_name,
               email: email

data/lib/actionkit_connector/version.rb

@@ -1,3 +1,3 @@
 module ActionkitConnector
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/test/connector_spec.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require_relative '../lib/actionkit_connector'
+
+describe 'Connector' do
+  before :each do
+    @connector = ActionKitConnector::Connector.new 'username', 'password', 'url'
+  end
+
+  it 'should create auth' do
+    expect(@connector.auth).to eql({username: 'username', password: 'password'})
+  end
+
+  it 'should change auth' do
+    @connector.password = 'new_password'
+    expect(@connector.auth).to eql({username: 'username', password: 'new_password'})
+  end
+
+  it 'should create base url' do
+    expect(@connector.base_url).to eql 'url'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionkit_connector
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Eric Boersma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - eric.boersma@gmail.com
@@ -68,6 +82,7 @@ files:
 - actionkit_connector.gemspec
 - lib/actionkit_connector.rb
 - lib/actionkit_connector/version.rb
+- test/connector_spec.rb
 homepage: https://github.com/EricBoersma/actionkit_connector
 licenses:
 - MIT
@@ -92,4 +107,5 @@ rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A gem for interacting with the ActionKit API.
-test_files: []
+test_files:
+- test/connector_spec.rb