blue_state_digital 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e8917551b5e90a45a3c448cf6f58804e9175bb3
+  data.tar.gz: b22e282e7cd262c56f50f51fe21cf64dd25cc51e
+SHA512:
+  metadata.gz: ae5ab46979afce07ca7d8af7b8ce5d28e99765c403055f901502948deb9109ac9dbb2a2f4c68e6e38c4e3fcd6f7c8905f49d14ecac4d29f4e5eb308e7bf93edb
+  data.tar.gz: 8667e65c8301f175e99ecf8ec7152849c8bb612e1c9ccd26773665b015bc7834e8cea566849b75dad4aa1c1d19d330dee761334d671bdc53c1cef93a63de2db3

data/.gitignore

@@ -0,0 +1,9 @@
+.idea
+*.swp
+Gemfile.lock
+test.rb
+*.tmproj
+tmp/
+pkg/
+example.rb
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+blue_state_digital

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "2.2.3"

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => "--color" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012, ControlShift, Ltd.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the ControlShift, Ltd. nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL CONTROLSHIFT LTD. BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,123 @@
+# Blue State Digital Gem
+
+[![Build Status](https://travis-ci.org/controlshift/blue_state_digital.svg?branch=master)](https://travis-ci.org/controlshift/blue_state_digital)
+
+## Usage
+
+```ruby
+gem blue_state_digital
+```
+
+Configuration:
+
+```ruby
+connection = BlueStateDigital::Connection.new(host:'foo.com' api_id: 'bar', api_secret: 'magic_secret')
+cons = BlueStateDigital::Constituent.new({firstname: 'George', lastname: 'Washington', emails: [{ email: 'george@washington.com'}]}.merge({connection: connection}))
+cons.save
+cons.Id # created constituent ID
+```
+
+Use the event machine adapter:
+
+```ruby
+connection = BlueStateDigital::Connection.new(host:'foo.com' api_id: 'bar', api_secret: 'magic_secret', adapter: :em_synchrony)
+```
+
+### Unsubscribes
+
+```ruby
+connection = BlueStateDigital::Connection.new(host:'foo.com' api_id: 'bar', api_secret: 'magic_secret')
+unsub = BlueStateDigital::EmailUnsubscribe.new({email: 'george@washington.com', reason: 'tea in the harbor'}.merge({connection: connection}))
+unsub.unsubscribe! # raises on error, returns true on success.
+
+
+### Dataset integration 
+
+[BSD API for uploading Dataset](https://cshift.cp.bsd.net/page/api/doc#---------------------upload_dataset-----------------)
+This creates a new personalization dataset from a slug, map_type, and CSV data, or if the supplied slug already exists, replaces the existing dataset. The CSV data can be attached by ```add_data_header``` and ```add_data_row``` methods. ```save``` method will upload the dataset and return true if successful.
+```ruby
+dataset=BlueStateDigital::Dataset.new({slug: "downballot_dataset",map_type:"downballot"}.merge(connection: connection))
+dataset.add_data_header(%w(index house house_link senate senate_link))
+dataset.add_data_row(%w(NJ01 Elect\ Camille\ Andrew http://camilleandrew.com Elect\ Bob\ Smith http://bobsmith.com))
+dataset.add_data_row(%w(NJ02 Elect\ David\ Kurkowski http://davidforcongress.com Elect\ Joe\ Jim http://joejim.com))
+dataset.save
+```
+If there is an error while saving, it will be available via ```dataset.errors```
+```ruby
+dataset=BlueStateDigital::Dataset.new({map_type:"downballot"}.merge(connection: connection))
+dataset.save
+=> false
+dataset.errors.full_messages
+=> ["slug can't be blank"]
+```
+
+[BSD API for listing Datasets](https://cshift.cp.bsd.net/page/api/doc#---------------------list_datasets-----------------)
+This returns a list of all personalization datasets.
+```ruby
+connection.datasets.get_datasets
+=> [
+  {
+      "dataset_id":42,
+      "slug":"my_dataset",
+      "rows":100,
+      "map_type":"state"
+  },
+  {
+      "dataset_id":43,
+      "slug":"downballot_dataset",
+      "rows":50,
+      "map_type":"downballot"
+  }
+]
+```
+
+[BSD API for deleting a Dataset](https://cshift.cp.bsd.net/page/api/doc#---------------------delete_dataset-----------------)
+This deletes a personalization dataset. 
+```ruby
+dataset=BlueStateDigital::Dataset.new({dataset_id: 420}.merge(connection: connection))
+dataset.delete
+```
+If there is any error ```delete``` will return ``false``` and the ```errors``` can be inspected for reasons.
+
+### Dataset Map integration 
+
+[BSD API for uploading Dataset Map](https://cshift.cp.bsd.net/page/api/doc#---------------------upload_dataset_map-----------------)
+This takes a CSV of dataset map data and creates or updates all of the mappings found in the CSV. The CSV data can be attached by ```add_data_header``` and ```add_data_row``` methods. ```save``` method will upload the dataset and return true if successful.
+```ruby
+dataset_map=BlueStateDigital::DatasetMap.new({}.merge(connection: connection))
+dataset_map.add_data_header(%w(cons_id downballot houseparty))
+dataset_map.add_data_row(%w(123456 NJ01 HP01))
+dataset_map.add_data_row(%w(123457,NJ02,HP01))
+dataset_map.save
+```
+If there is an error while saving, it will be available via ```dataset_map.errors```
+
+[BSD API for listing Dataset Maps](https://cshift.cp.bsd.net/page/api/doc#---------------------list_dataset_maps-----------------)
+This returns a list of all personalization dataset maps. 
+```ruby
+connection.dataset_maps.get_dataset_maps
+=> [
+    {
+        "map_id":1,
+        "type":"state"
+    },
+    {
+        "map_id":2,
+        "type":"downballot"
+    },
+    {
+        "map_id":3,
+        "type":"houseparty"
+    }
+]
+```
+
+[BSD API for deleting a Dataset Map](https://cshift.cp.bsd.net/page/api/doc#---------------------delete_dataset-----------------)
+This deletes a personalization dataset map. 
+```ruby
+dataset_map=BlueStateDigital::DatasetMap.new({map_id: 111}.merge(connection: connection))
+dataset.delete
+
+## CI
+[![Build Status](https://secure.travis-ci.org/controlshift/blue_state_digital.png)](http://travis-ci.org/controlshift/blue_state_digital)
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rspec_opts = '--color'
+end

data/blue_state_digital.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "blue_state_digital/version"
+
+Gem::Specification.new do |s|
+  s.name        = "blue_state_digital"
+  s.version     = BlueStateDigital::VERSION
+  s.authors     = ["Nathan Woodhull", "Sean Ho"]
+  s.email       = ["woodhull@gmail.com", "seanho@thoughtworks.com"]
+  s.homepage    = "https://github.com/controlshift/blue_state_digital"
+  s.summary     = "Simple wrapper for Blue State Digital."
+  s.description = %q{Simple wrapper for Blue State Digital.}
+  s.rubyforge_project = s.name
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "webmock", "1.9.0"
+  s.add_development_dependency "timecop"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-byebug"
+  s.add_development_dependency "rb-fsevent"
+  s.add_dependency "activesupport", ">= 3"
+  s.add_dependency "activemodel", ">= 3"
+  s.add_dependency "faraday", '>= 0.8.9'
+  s.add_dependency "builder"
+  s.add_dependency "nokogiri"
+  s.add_dependency "crack"
+  s.add_dependency "hashie"
+end

data/lib/blue_state_digital.rb

@@ -0,0 +1,32 @@
+require 'openssl'
+require 'builder'
+require 'nokogiri'
+require 'active_support/all'
+require 'active_model'
+require 'csv'
+require 'crack/xml'
+require 'faraday'
+require 'hashie'
+
+require "blue_state_digital/version" unless defined?(BlueStateDigital::VERSION)
+require "blue_state_digital/connection"
+require "blue_state_digital/collection_resource"
+require "blue_state_digital/api_data_model"
+require "blue_state_digital/address"
+require "blue_state_digital/email"
+require "blue_state_digital/phone"
+require "blue_state_digital/constituent"
+require "blue_state_digital/constituent_group"
+require "blue_state_digital/event_type"
+require "blue_state_digital/event"
+require "blue_state_digital/event_rsvp"
+require "blue_state_digital/contribution"
+require "blue_state_digital/dataset"
+require "blue_state_digital/dataset_map"
+require "blue_state_digital/error_middleware"
+require "blue_state_digital/email_unsubscribe"
+
+
+I18n.enforce_available_locales = false
+
+Faraday::Response.register_middleware :error_middleware  => lambda { BlueStateDigital::ErrorMiddleware }

data/lib/blue_state_digital/address.rb

@@ -0,0 +1,28 @@
+# <addr1>123 Fake St.</addr1>
+# <addr2></addr2>
+# <city>Anytown</city>
+# <state_cd>CA</state_cd>
+# <zip>92345</zip>
+# <zip_4>8311</zip_4>
+# <country>US</country>
+# <is_primary>1</is_primary>
+# <latitude>42.000</latitude>
+# <longitude>71.000</longitude>
+
+
+module BlueStateDigital
+  class Address < ApiDataModel
+    FIELDS = [:addr1, :addr2, :city, :state_cd, :zip, :zip_4, :country, :is_primary, :latitude, :longitude]
+    attr_accessor *FIELDS
+
+    def to_xml(builder = Builder::XmlMarkup.new)
+      builder.addr do | addr |
+        FIELDS.each do | field |
+          addr.__send__(field, self.send(field)) if self.send(field)
+        end
+      end
+      builder
+    end
+
+  end
+end

data/lib/blue_state_digital/api_data_model.rb

@@ -0,0 +1,31 @@
+module BlueStateDigital
+  class ApiDataModel
+    
+    class NoConnectionException < StandardError
+      def initialize
+        super("No connection available")
+      end
+    end
+    class FetchFailureException < StandardError
+      def initialize(msg)
+        super
+      end
+    end
+
+    FIELD = nil
+
+    attr_accessor :connection
+    def initialize(attrs = {})
+      attrs.each do |key, value|
+        if self.respond_to?("#{key}=")
+          self.send("#{key}=", value)
+        end
+      end
+    end
+
+    def to_hash
+      self.class::FIELDS.inject({}) {|h, key| h[key] = self.send(key); h}
+    end
+
+  end
+end

data/lib/blue_state_digital/collection_resource.rb

@@ -0,0 +1,14 @@
+module BlueStateDigital
+  class CollectionResource
+    class FetchFailureException < StandardError
+      def initialize(msg)
+        super
+      end
+    end
+    attr_accessor :connection
+
+    def initialize(connection)
+      self.connection = connection
+    end
+  end
+end

data/lib/blue_state_digital/connection.rb

@@ -0,0 +1,119 @@
+module BlueStateDigital
+  class Connection
+    API_VERSION = 2
+    API_BASE = '/page/api'
+    GRAPH_API_BASE = '/page/graph'
+
+    attr_reader :constituents, :constituent_groups, :datasets, :dataset_maps
+
+    def initialize(params = {})
+      @api_id = params[:api_id]
+      @api_secret = params[:api_secret]
+      @client = Faraday.new(:url => "https://#{params[:host]}/") do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        if defined?(Rails) && Rails.env.development?
+          faraday.response :logger                  # log requests to STDOUT
+        end
+        faraday.response :error_middleware
+        faraday.adapter(params[:adapter] || Faraday.default_adapter)  # make requests with Net::HTTP by default
+      end
+      set_up_resources
+    end
+
+    def perform_request(call, params = {}, method = "GET", body = nil)
+      perform_request_raw(call,params,method,body).body
+    end
+
+    def perform_request_raw(call, params = {}, method = "GET", body = nil)
+      path = API_BASE + call
+      if method == "POST" || method == "PUT"
+        @client.send(method.downcase.to_sym) do |req|
+          content_type = params.delete(:content_type) || 'application/x-www-form-urlencoded'
+          accept = params.delete(:accept) || 'text/xml'
+          req.url(path, extended_params(path, params))
+          req.body = body
+          req.options.timeout = 120
+          req.headers['Content-Type'] = content_type
+          req.headers['Accept'] = accept
+        end
+      else
+        @client.get(path, extended_params(path, params))
+      end
+    end
+
+    def perform_graph_request(call, params, method = 'POST')
+      path = GRAPH_API_BASE + call
+
+      if method == "POST"
+        @client.post do |req|
+          req.url(path, params)
+        end
+      end
+    end
+
+    def compute_hmac(path, api_ts, params)
+      # Support Faraday 0.9.0 forward
+      # Faraday now normalizes request parameters via sorting by default but also allows
+      # the params encoder to be configured by client.  It includes Faraday::NestedParamsEncoder
+      # and Faraday::FlatParamsEncoder, but a 3rd party one can be provided.
+      #
+      # When computing the hmac, we need to normalize/sort the exact same way.
+
+       if Faraday::VERSION == "0.8.9"
+         # do it the old way
+         canon_params= params.map { |k, v| "#{k.to_s}=#{v.to_s}" }.join('&')
+
+       else  # 0.9.0+ do it the new way
+
+         # Find out which one is in use or select default
+         params_encoder = @client.options[:params_encoder] || Faraday::Utils.default_params_encoder
+
+         # Call that params_encoder when creating signing string. Note we must unescape for BSD
+         canon_params = URI.decode_www_form_component(params_encoder.encode(params))
+
+       end
+       signing_string = [@api_id, api_ts, path, canon_params].join("\n")
+
+       OpenSSL::HMAC.hexdigest('sha1', @api_secret, signing_string)
+
+    end
+
+    def extended_params(path, params)
+      api_ts = Time.now.utc.to_i.to_s
+      extended_params = { api_ver: API_VERSION, api_id: @api_id, api_ts: api_ts }.merge(params)
+      extended_params[:api_mac] = compute_hmac(path, api_ts, extended_params)
+      extended_params
+    end
+
+    def set_up_resources # :doc:
+       @constituents = BlueStateDigital::Constituents.new(self)
+       @constituent_groups = BlueStateDigital::ConstituentGroups.new(self)
+       @datasets = BlueStateDigital::Datasets.new(self)
+       @dataset_maps = BlueStateDigital::DatasetMaps.new(self)
+    end
+
+    def get_deferred_results(deferred_id)
+      perform_request '/get_deferred_results', {deferred_id: deferred_id}, "GET"
+    end
+
+    def retrieve_results(deferred_id)
+      begin
+        return get_deferred_results(deferred_id)
+      rescue Faraday::Error::ClientError => e
+        if e.response[:status] == 503
+          return nil
+        end
+      end
+    end
+
+    def wait_for_deferred_result(deferred_id)
+      result = nil
+      while result.nil? || (result.respond_to?(:length) && result.length == 0)
+        result = retrieve_results(deferred_id)
+        sleep(2) if result.nil? || (result.respond_to?(:length) && result.length == 0)
+      end
+      result
+    end
+
+  end
+end