saas_runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67a6f0c7c6583703dda6d1ae28dafa1be6ff9ced
+  data.tar.gz: 0d53a46109465f0e668d2a4424d6fbacf2902192
+SHA512:
+  metadata.gz: 14dfa1de39f3c122a20ec61385bc1190ac94c32f355cc7adb01a062fe653273fe47f551c772347b264d5fdbd18c12e01024ba1e70e2aa1656dbd8caa4b26f57e
+  data.tar.gz: e4ad8430d1d14f0098d59d17c9749299460ea253212d498eb3a87c5fce4a8075cbb88ddeda962a4703c7041ad0f8842fd54b1815728aa3a5cdd68a9097a4decc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in saas_runner.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Simpleweb Ltd
+
+MIT License
+
+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,87 @@
+# SaasRunner
+
+[![Build Status](https://travis-ci.org/simpleweb/saasrunner-client-ruby.svg?branch=master)](https://travis-ci.org/simpleweb/saasrunner-client-ruby)
+
+Ruby client library for the SaaS Runner REST API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'saas_runner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install saas_runner
+
+## Usage
+
+Refer to the [SaaS Runner API docs](http://docs.saasrunner.apiary.io/) for more information on the API.
+
+First create a new client object with your SaaS Runner API key
+
+```ruby
+client = SaasRunner::Client.new(api_key: 'YOUR API KEY')
+```
+
+And then call the relevant resource
+
+### Subscribers
+
+Create a new subscriber
+
+```ruby
+client.subscribers.create!(subscriber_uid: 'ABC123')
+```
+
+### Transactions
+
+Create a new transaction charge using the three digit letter code for the currency (eg USD or GBP)
+
+```ruby
+client.transactions.charge!(subscriber_uid: 'ABC123', transaction_uid: '123', amount_in_cents: 1000, currency: 'USD')
+```
+
+Create a new transaction refund
+
+```ruby
+client.transactions.refund!(subscriber_uid: 'ABC123', transaction_uid: '124', amount_in_cents: 150, currecny: 'USD')
+```
+
+### Activations
+
+```ruby
+client.activations.create!(subscriber_uid: 'ABC123')
+```
+
+### Events
+
+List all events
+
+```ruby
+client.events.index
+```
+
+List a single event
+
+```ruby
+client.events.show(568)
+```
+
+Delete an event
+
+```ruby
+client.events.destroy!(568)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :console do
+  sh "bundle exec irb -rubygems -I lib -r saas_runner.rb"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/lib/faraday/response/raise_response_error.rb

@@ -0,0 +1,14 @@
+require 'faraday'
+require 'saas_runner/response_error'
+
+module Faraday
+  class Response::RaiseResponseError < Response::Middleware
+    def on_complete(env)
+      status = env[:status].to_i
+
+      if (400..599).include?(status)
+        raise SaasRunner::ResponseError.new(env)
+      end
+    end
+  end
+end

data/lib/saas_runner.rb

@@ -0,0 +1,14 @@
+require 'saas_runner/version'
+
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie/mash'
+
+require 'faraday/response/raise_response_error'
+
+require 'saas_runner/client'
+require 'saas_runner/resource/subscriber'
+require 'saas_runner/resource/transaction'
+require 'saas_runner/resource/activation'
+require 'saas_runner/resource/event'

data/lib/saas_runner/client.rb

@@ -0,0 +1,66 @@
+module SaasRunner
+  class Client
+    attr_reader :api_key, :api_host
+
+    def initialize(options = {})
+      @api_key = options.fetch(:api_key)
+      @api_host = options.fetch(:api_host, 'api.saasrunner.com')
+    end
+
+    # Public: Access the subscribers resource
+    #
+    # Returns a Resource::Subscriber
+    def subscribers
+      @subscribers ||= Resource::Subscriber.new(self)
+    end
+
+    def transactions
+      @transactions ||= Resource::Transaction.new(self)
+    end
+
+    def activations
+      @activations ||= Resource::Activation.new(self)
+    end
+
+    def events
+      @events ||= Resource::Event.new(self)
+    end
+
+    def get(path, params)
+      request(:get, path, params)
+    end
+
+    def post(path, body)
+      request(:post, path, {}, body)
+    end
+
+    def delete(path, params)
+      request(:delete, path, params)
+    end
+
+    private
+
+    def request(method, path, params = {}, body = {})
+      connection.send(method) do |request|
+        request.headers['X-API-Key'] = api_key
+        request.params = params
+        request.body = body
+
+        request.url(path)
+      end
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: "http://#{api_host}") do |builder|
+        builder.request :url_encoded
+
+        builder.use Faraday::Response::RaiseResponseError
+
+        builder.use FaradayMiddleware::Mashify
+        builder.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+
+        builder.adapter :net_http
+      end
+    end
+  end
+end

data/lib/saas_runner/resource/activation.rb

@@ -0,0 +1,16 @@
+module SaasRunner
+  module Resource
+    class Activation
+      attr_reader :client, :response
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create!(params = {})
+        @response = client.post('/activations', { activation: params })
+        @response.body
+      end
+    end
+  end
+end

data/lib/saas_runner/resource/event.rb

@@ -0,0 +1,26 @@
+module SaasRunner
+  module Resource
+    class Event
+      attr_reader :client, :response
+
+      def initialize(client)
+        @client = client
+      end
+
+      def index(params = {})
+        @response = client.get('/events', params)
+        @response.body
+      end
+
+      def show(id, params = {})
+        @response = client.get("/events/#{id}", params)
+        @response.body
+      end
+
+      def destroy!(id, params = {})
+        @response = client.delete("/events/#{id}", params)
+        @response.body
+      end
+    end
+  end
+end

data/lib/saas_runner/resource/subscriber.rb

@@ -0,0 +1,16 @@
+module SaasRunner
+  module Resource
+    class Subscriber
+      attr_reader :client, :response
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create!(params = {})
+        @response = client.post('/subscribers', { subscriber: params })
+        @response.body
+      end
+    end
+  end
+end

data/lib/saas_runner/resource/transaction.rb

@@ -0,0 +1,21 @@
+module SaasRunner
+  module Resource
+    class Transaction
+      attr_reader :client, :response
+
+      def initialize(client)
+        @client = client
+      end
+
+      def charge!(params = {})
+        @response = client.post('/transactions/charge', { transaction: params })
+        @response.body
+      end
+
+      def refund!(params = {})
+        @response = client.post('/transactions/refund', { transaction: params })
+        @response.body
+      end
+    end
+  end
+end

data/lib/saas_runner/response_error.rb

@@ -0,0 +1,34 @@
+module SaasRunner
+  class ResponseError < StandardError
+    attr_reader :response, :body, :status, :method, :url
+
+    def initialize(response = nil)
+      @response = response
+
+      @body = response[:body]
+      @status = response[:status].to_i
+      @method = response[:method].to_s.upcase
+      @url = response[:url]
+
+      super
+    end
+
+    def to_s
+      "#{status} #{method} #{url} | Errors: #{errors}"
+    end
+
+    private
+
+    def errors
+      return body if body.kind_of?(String) 
+
+      messages = []
+
+      body.each do |error|
+        messages.push "#{error.field} #{error.message}"
+      end
+
+      messages.join(', ')
+    end
+  end
+end

data/lib/saas_runner/version.rb

@@ -0,0 +1,3 @@
+module SaasRunner
+  VERSION = "0.1.0"
+end

data/saas_runner.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'saas_runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "saas_runner"
+  spec.version       = SaasRunner::VERSION
+  spec.authors       = ["Paul Springett", "Peter Rhoades"]
+  spec.email         = ["paul@simpleweb.co.uk", "pete@simpleweb.co.uk"]
+  spec.description   = %q{Ruby client library for the Saas Runner REST API}
+  spec.summary       = %q{Ruby client library for the Saas Runner REST API}
+  spec.homepage      = "https://github.com/simpleweb/saasrunner-client-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.8"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "hashie", "~> 2.0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+end

data/spec/cassettes/SaasRunner_Client/activations/should_add_an_activation.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.saasrunner.com/activations
+    body:
+      encoding: US-ASCII
+      string: activation%5Bsubscriber_uid%5D=sub1398853222
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      X-API-Key:
+      - 00b4040a-ed54-4524-a33e-f992298383cc
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message:
+    headers:
+      server:
+      - nginx/1.4.4
+      date:
+      - Wed, 30 Apr 2014 10:20:18 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      status:
+      - 201 Created
+      x-frame-options:
+      - SAMEORIGIN
+      x-xss-protection:
+      - 1; mode=block
+      x-content-type-options:
+      - nosniff
+      x-ua-compatible:
+      - chrome=1
+      etag:
+      - '"4ae4e39e2a9ce0e906cd85f2b6d0a61f"'
+      cache-control:
+      - max-age=0, private, must-revalidate
+      x-request-id:
+      - a11e57fe-c778-447e-8bba-6898719ee698
+      x-runtime:
+      - '0.009839'
+    body:
+      encoding: UTF-8
+      string: '{"activation":{"id":8356,"subscriber_uid":"sub1398853222","dated_at":"2014-04-30","meta":null,"errors":[]}}'
+    http_version:
+  recorded_at: Wed, 30 Apr 2014 10:20:22 GMT
+recorded_with: VCR 2.9.0