purpose-platform-queued-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c8a6b6b0b727f32670e4b6d6ac8aa7643b8a4ae
+  data.tar.gz: bc5bdd7aaa19531c9f21c81896fef25e74103546
+SHA512:
+  metadata.gz: 005f8995c3f2c48848e351b64825e4f2433d1fb82b50feb099c97369b9aaa365926702f44f6c74adb84f9a82e27b8aac0c341400e6f88209887c58c51ef238cc
+  data.tar.gz: 19cf506f1df638d7cc5d4aa931a7db8a3ced770ffb0496df17693e29592ae3df16e9ecb19670d4d3368129a8fdc74a9acbb7a98132770089a24cb197214c7b6e

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.ruby-gemset

@@ -0,0 +1 @@
+purpose-platform-queued-client

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p645

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+gem 'vertebrae'
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'pry'
+  gem 'pry-byebug'
+  gem "webmock", ">=0"	
+  gem "rspec", ">=0"
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/Gemfile.lock

@@ -0,0 +1,120 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    builder (3.2.2)
+    byebug (5.0.0)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.2)
+    highline (1.7.2)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.2.0)
+      byebug (~> 5.0)
+      pry (~> 0.10)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    vertebrae (0.2.11)
+      activesupport
+      faraday
+      faraday_middleware
+      hashie
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  pry
+  pry-byebug
+  rspec
+  shoulda
+  vertebrae
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 ChangeSprout, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,17 @@
+# purpose-platform-queued-client
+
+Ruby interface for the queued API service fronting the Purpose Platform which Fight for the Future uses.
+
+## Usage
+
+```ruby
+pp = PurposePlatformQueuedClient.new(host: 'your.queued.purposeplatform.org')
+pp.action.create(first_name: 'George', last_name: 'Washington', email: 'george@washington.com', org: 'foo')
+pp.unsubscribe.create(email: 'foo@bar.com')
+```
+
+## Copyright
+
+Copyright (c) 2015 ChangeSprout, Inc. See LICENSE for
+further details.
+

data/Rakefile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "purpose-platform-queued-client"
+  gem.homepage = "http://github.com/woodhull/purpose-platform-queued-client"
+  gem.license = "MIT"
+  gem.summary = %Q{FFTF/Purpose Platform API}
+  gem.description = %Q{Ruby interface for the queued API service fronting the Purpose Platform which Fight for the Future uses.}
+  gem.email = "nathan@controlshiftlabs.com"
+  gem.authors = ["Nathan Woodhull"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/purpose-platform-queued-client.rb

@@ -0,0 +1,16 @@
+require 'vertebrae'
+require 'purpose-platform-queued-client/client'
+require 'purpose-platform-queued-client/base'
+require 'purpose-platform-queued-client/action'
+require 'purpose-platform-queued-client/unsubscribe'
+
+
+module PurposePlatformQueuedClient
+  extend Vertebrae::Base
+
+  class << self
+    def new(options = {}, &block)
+      PurposePlatformQueuedClient::Client.new(options, &block)
+    end
+  end
+end

data/lib/purpose-platform-queued-client/action.rb

@@ -0,0 +1,32 @@
+module PurposePlatformQueuedClient
+  class Action < Base
+    # guard: Bot prevention! You must pass a blank string for this field
+    # hp_enabled: Bot prevention! You must pass a checked checkbox for this field. Note the checkbox should be hidden from the user.
+    # hp_disabled: Bot prevention! You must not pass this field, or pass an unchecked checkbox, which should be hidden from the user.
+    # member[first_name]: (String) The first name (or full name) of the user. Since many forms don't collect last name as a separate field, you can put the whole thing in this one.
+    # member[last_name]: (String) Last name of user
+    # member[email]: (String) Email address
+    # member[street_address]: (String) Street address of user
+    # member[postcode]: (String) Zip / Post code of user
+    # member[country]: (String, limit 2 characters) Two character ISO code for country.
+    # tag: (String) The slug name (eg. "save-the-whales') for the campaign.
+    # org: (String) MUST BE "fftf"
+
+    def default_params
+      {
+        guard: '',
+        hp_enabled: '1',
+        hp_disabled: '0'
+      }
+    end
+
+    def base_path
+    	'action'
+    end
+
+    def create(params)
+      params = params.merge(default_params)
+      super(params)
+    end
+  end
+end

data/lib/purpose-platform-queued-client/base.rb

@@ -0,0 +1,7 @@
+module PurposePlatformQueuedClient
+  class Base < Vertebrae::Model
+    def create(params)
+      resp = client.post_request(base_path, params)
+    end
+  end
+end

data/lib/purpose-platform-queued-client/client.rb

@@ -0,0 +1,68 @@
+module PurposePlatformQueuedClient
+  class Client < Vertebrae::API
+    def action
+      @action ||= PurposePlatformQueuedClient::Action.new(client: self)
+    end
+
+    def unsubscribe
+      @unsubscribe ||= PurposePlatformQueuedClient::Unsubscribe.new(client: self)
+    end 
+
+    private 
+
+    def default_options
+      {
+        ssl: { verify: false },
+        user_agent: 'PurposePlatformQueuedClient',
+        prefix: '',
+        content_type: 'application/x-www-form-urlencoded'
+      }
+    end
+
+    def request(method, path, params, options) # :nodoc:
+      if !::Vertebrae::Request::METHODS.include?(method)
+        raise ArgumentError, "unknown http method: #{method}"
+      end
+
+      path =  connection.configuration.prefix + '/' + path
+
+      ::Vertebrae::Base.logger.debug "EXECUTED: #{method} - #{path} with #{params} and #{options}"
+
+      connection.connection.send(method) do |request|
+
+        case method.to_sym
+          when *(::Vertebrae::Request::METHODS - ::Vertebrae::Request::METHODS_WITH_BODIES)
+            request.url(path, params)
+          when *::Vertebrae::Request::METHODS_WITH_BODIES
+            request.path = path
+            request.body = params unless params.empty?
+        end
+      end
+    end
+
+
+    def extract_data_from_params(params) # :nodoc:
+      if params.has_key?('data') && params['data'].present?
+        return params['data']
+      else
+        return params
+      end
+    end
+
+    def setup
+      connection.stack do |builder|
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+
+        builder.use Faraday::Response::Logger if ENV['DEBUG']
+
+        builder.use FaradayMiddleware::Mashify
+        builder.use FaradayMiddleware::ParseJson
+
+        builder.adapter connection.configuration.adapter
+      end
+    end
+  end
+end
+
+ 

data/lib/purpose-platform-queued-client/unsubscribe.rb

@@ -0,0 +1,7 @@
+module PurposePlatformQueuedClient
+  class Unsubscribe < Base
+    def base_path
+      'unsubscribe'
+    end
+  end
+end

data/purpose-platform-queued-client.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: purpose-platform-queued-client 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "purpose-platform-queued-client"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Nathan Woodhull"]
+  s.date = "2015-08-13"
+  s.description = "Ruby interface for the queued API service fronting the Purpose Platform which Fight for the Future uses."
+  s.email = "nathan@controlshiftlabs.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    ".ruby-gemset",
+    ".ruby-version",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/purpose-platform-queued-client.rb",
+    "lib/purpose-platform-queued-client/action.rb",
+    "lib/purpose-platform-queued-client/base.rb",
+    "lib/purpose-platform-queued-client/client.rb",
+    "lib/purpose-platform-queued-client/unsubscribe.rb",
+    "purpose-platform-queued-client.gemspec",
+    "spec/client_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/woodhull/purpose-platform-queued-client"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.8"
+  s.summary = "FFTF/Purpose Platform API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<vertebrae>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<pry-byebug>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<vertebrae>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<pry-byebug>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<vertebrae>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<pry-byebug>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+  end
+end
+

data/spec/client_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe PurposePlatformQueuedClient::Client do
+  specify { expect(subject).to respond_to :action }
+  specify { expect(subject).to respond_to :unsubscribe }
+
+  describe "instantiated" do
+    subject { described_class.new(options) }
+
+    context 'process_basic_auth' do
+      let(:options) { { :host => 'foo.bar.com' } }
+      let(:config) { subject.connection.configuration  }
+      specify { expect(config.host).to eq 'foo.bar.com' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'purpose-platform-queued-client'
+require 'webmock/rspec'
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.color = true
+end
+
+RSpec.configure do |config|
+  config.include WebMock::API
+
+  config.before(:each) do
+    WebMock.reset!
+  end
+  config.after(:each) do
+    WebMock.reset!
+  end
+end
+
+def stub_get(path)
+  stub_pp_request(:get, path)
+end
+
+def stub_post(path)
+  stub_pp_request(:post, path)
+end
+
+def stub_pp_request(method, path)
+  prefix = PurposePlatformQueuedClient.new.connection.configuration.prefix.to_s
+  stub_request(method, "https://test.com" + prefix + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(File.join(fixture_path, '/', file))
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: purpose-platform-queued-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Woodhull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vertebrae
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Ruby interface for the queued API service fronting the Purpose Platform
+  which Fight for the Future uses.
+email: nathan@controlshiftlabs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/purpose-platform-queued-client.rb
+- lib/purpose-platform-queued-client/action.rb
+- lib/purpose-platform-queued-client/base.rb
+- lib/purpose-platform-queued-client/client.rb
+- lib/purpose-platform-queued-client/unsubscribe.rb
+- purpose-platform-queued-client.gemspec
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/woodhull/purpose-platform-queued-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: FFTF/Purpose Platform API
+test_files: []