porpoise_external_actions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55a29b645eba55bed8dba2ee37d8ddb4ac008b2c
+  data.tar.gz: b54bbc0c9f8bc0aeeed4d59350bfb2f8216cdf88
+SHA512:
+  metadata.gz: 074b9c878017d82b27cbee8cf800c7dc028809b37bee591793dddf171316a1b13a3bfc04d37cacf81f212b5968e099445c608cbf5d4c1494b5910a354feaa67c
+  data.tar.gz: f0108f4170f7b0e40282baebe08514d6531ff985891464e5294f24c3ba396585560bd0385a84c4392c822a471a610d7d7fe39af8a1659734b44a6b10da050d2f

data/.ruby-gemset

@@ -0,0 +1 @@
+porpoise_external_actions

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'vertebrae'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'webmock'
+  gem 'pry'
+  gem 'pry-debugger'
+  gem "rspec"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,108 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.2.2)
+    coderay (1.0.9)
+    columnize (0.3.6)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.0)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.2)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    safe_yaml (0.9.4)
+    slop (3.4.6)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.37)
+    vertebrae (0.2.0)
+      activesupport
+      faraday
+      faraday_middleware
+      hashie
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler (~> 1.8.4)
+  pry
+  pry-debugger
+  rspec
+  vertebrae
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 ControlShift Ltd.
+
+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,30 @@
+porpoise_external_actions
+=========================
+
+An API client in ruby for the Purpose Platform External Actions API
+
+[![Build Status](https://travis-ci.org/controlshift/porpoise_external_actions.png)](https://travis-ci.org/controlshift/porpoise_external_actions)
+
+## Usage
+
+```
+require 'porpoise_external_actions'
+
+# setup an API client.
+client = PorpoiseExternalActions.new(host: 'test.herokuapp.com', username: 'controlshift', password: 'controlshift', movement_id: 'controlshift')
+
+# send an action
+response = client.action.create { source: 'foo', role: 'signer', action_slug: "slug", action_language_iso: "en", activity: "action_taken", user: { email: "foo@bar.com"}}
+
+response # is a Farraday::Response object, API always returns an empty body with 201 status.
+```
+
+### Exceptions
+
+* PorpoiseInvalidException - thrown for validation exceptions, when API return 422. Contains error message raw response.
+* PorpoiseException - thrown when endpoint returns 500. Contains error message and raw http response
+
+
+## Purpose API Documentation
+
+https://github.com/PurposeOpen/Platform/wiki/Create-External-Activity-Event

data/Rakefile

@@ -0,0 +1,49 @@
+# 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://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "porpoise_external_actions"
+  gem.homepage = "http://github.com/controlshift/porpoise_external_actions"
+  gem.license = "MIT"
+  gem.summary = %Q{API client for Purpose Platform External Actions }
+  gem.description = %Q{An API client for the Purpose Platform}
+  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
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "porpoise_external_actions #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/porpoise_external_actions.rb

@@ -0,0 +1,17 @@
+require 'vertebrae'
+require 'porpoise_external_actions/model'
+require 'porpoise_external_actions/action'
+require 'porpoise_external_actions/client'
+require 'porpoise_external_actions/exception_middleware'
+
+module PorpoiseExternalActions
+  extend Vertebrae::Base
+
+  class << self
+    def new(options = {})
+      PorpoiseExternalActions::Client.new(options) do
+
+      end
+    end
+  end
+end

data/lib/porpoise_external_actions/action.rb

@@ -0,0 +1,11 @@
+module PorpoiseExternalActions
+  class Action < PorpoiseExternalActions::Model
+    def base_path
+      normalized_base_path('external_activity_events')
+    end
+
+    def create(params)
+      client.post_request(base_path, params)
+    end
+  end
+end

data/lib/porpoise_external_actions/client.rb

@@ -0,0 +1,48 @@
+module PorpoiseExternalActions
+  class Client < Vertebrae::API
+    def action
+      @action ||= PorpoiseExternalActions::Action.new(client: self)
+    end
+
+    def default_options
+      {
+        user_agent: 'PorpoiseExternalActionsGem',
+        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 setup
+      connection.stack do |builder|
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Vertebrae::Request::BasicAuth, connection.configuration.authentication if connection.configuration.authenticated?
+
+        builder.use Faraday::Response::Logger if ENV['DEBUG']
+
+        builder.use PorpoiseExternalActions::ExceptionMiddleware # Vertebrae::Response::RaiseError
+        builder.adapter connection.configuration.adapter
+      end
+    end
+  end
+end

data/lib/porpoise_external_actions/exception_middleware.rb

@@ -0,0 +1,35 @@
+module PorpoiseExternalActions
+  class ExceptionMiddleware < Faraday::Response::Middleware
+
+    def on_complete(response)
+      status_code = response[:status].to_i
+      if status_code == 500
+        message = JSON.parse(response[:body])['error']
+        raise PorpoiseException.new(message, response)
+      elsif status_code == 422
+        fields = JSON.parse(response[:body])
+        raise PorpoiseInvalidException.new("validation error", response, fields)
+      end
+    end
+  end
+
+  class PorpoiseException < Exception
+    attr_accessor :message, :http_response
+
+    def initialize(message, response = nil)
+      super(message)
+      self.message = message
+      self.http_response = response
+    end
+  end
+
+  class PorpoiseInvalidException < PorpoiseException
+    attr_accessor :fields
+
+    def initialize message, response, fields = nil
+      super(message, response)
+      self.fields = fields
+    end
+  end
+
+end

data/lib/porpoise_external_actions/model.rb

@@ -0,0 +1,14 @@
+module PorpoiseExternalActions
+  class Model < Vertebrae::Model
+    attr_accessor :movement_id
+
+    def initialize(attrs = {})
+      super(attrs)
+      self.movement_id = client.connection.options[:movement_id] if client.present?
+    end
+
+    def normalized_base_path(path)
+      "api/movements/#{movement_id}/#{path}/"
+    end
+  end
+end

data/spec/action_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe PorpoiseExternalActions::Action do
+
+  let(:client) { PorpoiseExternalActions::Client.new(host: 'test.com', username: 'controlshift', password: 'controlshift', movement_id: 'controlshift') }
+  subject { PorpoiseExternalActions::Action.new({client: client }) }
+
+  context 'with an http post' do
+    let(:request_path) { '/api/movements/controlshift/external_activity_events/' }
+    let(:request_body) { params }
+    let(:status) { 201 }
+    let(:body) {''}
+
+    let(:params) { { source: 'foo', role: 'signer', action_slug: "slug", action_language_iso: "en", activity: "action_taken", user: {email: 'foo@bar.com'}} }
+
+    before(:each) do
+      stub_post(request_path).with(body: request_body).to_return(:body => body, :status => status,
+                                                                 :headers => { content_type: "application/json; charset=utf-8"})
+    end
+
+    describe "creating actions" do
+      context 'post returns 500' do
+        let(:status) { 500 }
+        let(:body){ '{"error":"no_method_error"}' }
+
+        it 'should return an error hash when a remote exception occurs' do
+          lambda { subject.create(params) }.should raise_exception(PorpoiseExternalActions::PorpoiseException, 'no_method_error')
+        end
+      end
+
+
+      context 'post returns 201' do
+        let(:status) {201}
+        it 'should return true when a successful action is created' do
+          subject.create(params).class.should == Faraday::Response
+        end
+      end
+
+      context 'post returns a 422' do
+        let(:status) {422}
+        let(:body) { '{"email":["is invalid"]}' }
+
+        it 'should return a hash when a validation error occurs' do
+          lambda { subject.create(params) }.should raise_exception(PorpoiseExternalActions::PorpoiseInvalidException, 'validation error')
+        end
+      end
+    end
+
+  end
+
+
+
+end

data/spec/client_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe PorpoiseExternalActions::Client do
+
+  describe "initialized" do
+    subject { described_class.new(options) }
+    let(:handlers) { subject.connection.stack.handlers }
+
+
+    context 'process_basic_auth' do
+      let(:options) { { :basic_auth => 'login:password' } }
+      let(:config) { subject.connection.configuration  }
+      specify { config.username.should eq 'login' }
+      specify { config.password.should eq 'password' }
+      specify { handlers.should include(Vertebrae::Request::BasicAuth)  }
+    end
+
+    context 'stack' do
+      let(:options) { {} }
+      specify { handlers.should include(Faraday::Request::UrlEncoded)  }
+      specify { handlers.should include(PorpoiseExternalActions::ExceptionMiddleware)  }
+    end
+  end
+
+  describe 'configure models' do
+    let(:client) { PorpoiseExternalActions.new(host: 'test.com', username: 'controlshift', password: 'controlshift', movement_id: 'controlshift') }
+
+    it 'should set the movement_id from the connection' do
+      client.action.movement_id.should == 'controlshift'
+    end
+
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe PorpoiseExternalActions::Model do
+
+  it 'should normalize the base path' do
+    subject.stub(:movement_id).and_return('controlshift')
+    subject.normalized_base_path('foo').should == "api/movements/controlshift/foo/"
+  end
+
+
+end

data/spec/porpoise_external_actions_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe PorpoiseExternalActions do
+  specify { subject.should respond_to :action }
+  specify { subject.new.should be_a(PorpoiseExternalActions::Client)}
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'webmock/rspec'
+
+require 'porpoise_external_actions'
+
+# 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_enabled = true
+  config.include WebMock::API
+
+  config.before(:each) do
+    WebMock.reset!
+  end
+  config.after(:each) do
+    WebMock.reset!
+  end
+end
+
+def stub_get(path)
+  stub_porpoise_request(:get, path)
+end
+
+def stub_post(path)
+  stub_porpoise_request(:post, path)
+end
+
+def stub_porpoise_request(method, path)
+  stub_request(method, "https://controlshift:controlshift@test.com" + 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,162 @@
+--- !ruby/object:Gem::Specification
+name: porpoise_external_actions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Woodhull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 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: 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: 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-debugger
+  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: bundler
+  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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: An API client for the Purpose Platform
+email: nathan@controlshiftlabs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/porpoise_external_actions.rb
+- lib/porpoise_external_actions/action.rb
+- lib/porpoise_external_actions/client.rb
+- lib/porpoise_external_actions/exception_middleware.rb
+- lib/porpoise_external_actions/model.rb
+- spec/action_spec.rb
+- spec/client_spec.rb
+- spec/model_spec.rb
+- spec/porpoise_external_actions_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/controlshift/porpoise_external_actions
+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.0.7
+signing_key: 
+specification_version: 4
+summary: API client for Purpose Platform External Actions
+test_files: []