whiplash-app 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c39a9db7a5846ef00446af1eddd5be55c8240dc4
+  data.tar.gz: 15cb72ab9cc973219e8edba2fed1c15893fdeb7c
+SHA512:
+  metadata.gz: a23d95521223c0ae13609e99a782bc63064be34e74b08ee87be3da7472550d84c27634308da50cfd5dbd647ed94c5b397a07b6253a58041f00efc70e5d8aacf1
+  data.tar.gz: 86276e51e588c597897f9578bc2e1d59e829ca323cfae103f425ca46330a5db642c452174f546f1e1cdf9bf9781ae06e1181f0855b1e2d424ab53197370341b2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,141 @@
+# whiplash-app  
+
+The whiplash-app gem allows your Whiplash application to access the Whiplash
+API and perform authentication, signatures and signature verification, and basic
+CRUD functions against the api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'whiplash-app'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whiplash-app
+
+## Usage
+
+###Authentication
+In order to authenticate, make sure the following `ENV` vars are set:
+
+```ruby
+ENV["WHIPLASH_CLIENT_ID"]
+ENV["WHIPLASH_CLIENT_SECRET"]
+ENV["WHIPLASH_CLIENT_SCOPE"]
+```
+Once those are set, authentication is handled in app.  While authentication is
+mostly baked into the calls, there is a method that allows for getting the app's
+token from the main app: `Whiplash::App.token`.
+
+### API URL
+In order to set your api url, you can use the following environment URL:
+```
+ENV["WHIPLASH_API_URL"]
+```
+If it isn't set, then the API URL defaults to either `https://testing.whiplashmerch.com` (test or dev environment) or `https://www.whiplashmerch.com` (prod environment).
+
+###Rails AR type calls
+
+In order to make the use of the gem seem more "AR-ish", we've added AR oriented methods that can be used for basic object creation/deletion/updating/viewing. The basic gist of these AR style CRUD methods is that they will all follow the same pattern.  If you are performing a collection action, such as `create` or `find`, the pattern is this:
+
+```ruby
+Whiplash::App.create(resource, params, headers)
+```
+
+For member actions, such as `show`, or `destroy` methods, the pattern is this:
+
+```ruby
+Whiplash::App.find(resource, id, headers)
+Whiplash::App.destroy(resource, id, headers)
+```
+
+Finally, for `update` calls, it's a mixture of those:
+
+```ruby
+Whiplash::App.update(resource, id, params_to_update, headers)
+```
+
+So, basic AR style calls can be performed like so:
+
+```ruby
+Whiplash::App.find_all('orders', {}, { customer_id: 187 })
+Whiplash::App.find('orders', 1)
+Whiplash::App.create('orders', { key: "value", key2: "value" }, { customer_id: 187 } )
+Whiplash::App.update('orders', 1, { key: "value"}, { customer_id: 187 } )
+Whiplash::App.destroy('orders', 1, { customer_id: 187 } )
+Whiplash::App.count('customers') #unlike other calls, which return Faraday responses, this call returns an integer.
+```
+
+###CRUD Wrapper methods
+In reality, all of these methods are simply wrapper methods around simple `GET/POST/PUT/DELETE` wrappers on Faraday, so if you want to get more granular,you can also make calls that simply reference the lower level REST verb:
+
+```ruby
+Whiplash::App.get('orders', {}, {})
+```
+Which will return all orders and roughly correspond to an index call. If you need to use `Whiplash::App` for nonRESTful calls, simply drop the full endpoint in as your first argument:
+
+```ruby
+Whiplash::App.get('orders/non_restful_action', {}, {})
+```
+`POST`, `PUT`, and `DELETE` calls can be performed in much the same way:
+```ruby
+Whiplash::App.post(endpoint, params, headers) #POST request to the specified endpoint passing the payload in params
+```
+```ruby
+Whiplash::App.put(endpoint, params, headers) #PUT request to the specified endpoint passing the payload in params
+```
+```ruby
+Whiplash::App.delete(endpoint, params, headers) #DELETE request to the specified endpoint.  Params would probably just be an id.
+```
+
+*IMPORTANT!!!! PLEASE READ!*
+It's best if possible to use the AR style methods.  They hide a lot of issues with the way Faraday handles params.  For example, this should, in theory, work:
+```ruby
+Whiplash::App.get('orders', {id: 1}, {customer_id: 187})  
+```
+BUT, due to the way Faraday handles params, this would not, as expected, route to `orders#show` in the Whiplash App, but would instead route to `orders#index`, so it wouldn't return the expected singular order with an ID of 1, but all orders for that customer.
+
+The gem works best when the base CRUD methods are used ONLY for situations where a singular endpoint can't be reached, such as a cancel action, or uncancel, which would have to be done like so:
+```ruby
+Whiplash::App.post('orders/1/cancel', {}, {customer_id: 187})
+```
+
+
+###Signing and Verifying.
+`whiplash-app` supports signing and verifying signatures like so:
+```ruby
+Whiplash::App.signature(request_body)
+```
+and verifications are done like so:
+```ruby
+Whiplash::App.verified?(request)
+```  
+
+###Caching
+`whiplash-app` is Cache agnostic, relying on the `moneta` gem to provide that
+interface.  However, if you intend to specify `REDIS` as your key-value store of
+choice, it's dead simple.  Simply declare the following variables:
+```
+ENV["REDIS_HOST"]
+ENV["REDIS_PORT"]
+ENV["REDIS_PASSWORD"]
+ENV["REDIS_NAMESPACE"]
+```
+If those are provided, `moneta` will use your redis connection and will namespace your cache storage under the redis namespace.  By default, if you do not declare a `REDIS_NAMESPACE` value, the app will default to the `WHIPLASH_CLIENT_ID`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/whiplash-app.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whiplash/app"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/whiplash/app/api_config.rb

@@ -0,0 +1,23 @@
+module Whiplash
+  module App
+    module ApiConfig
+
+      def api_url
+        if defined?(Rails)
+          %w(development test).include?(Rails.env.to_s) ? testing_url : production_url
+        else
+          ENV["WHIPLASH_API_URL"]
+        end
+      end
+
+      def production_url
+        ENV["WHIPLASH_API_URL"] || "https://www.getwhiplash.com"
+      end
+
+      def testing_url
+        ENV["WHIPLASH_API_URL"] || "https://testing.getwhiplash.com"
+      end
+
+    end
+  end
+end

data/lib/whiplash/app/caching.rb

@@ -0,0 +1,22 @@
+require "moneta"
+require "whiplash/app/moneta/namespace"
+module Whiplash
+  module App
+    module Caching
+
+      def cache_store
+        if ENV["REDIS_HOST"]
+          store = Moneta.new(:Redis, host: ENV["REDIS_HOST"], port: ENV["REDIS_PORT"], password: ENV["REDIS_PASSWORD"], expires: 7200)
+          Moneta::Namespace.new store, namespace_value
+        else
+          Moneta.new(:File, dir: "tmp", expires: 7200)
+        end
+      end
+
+      def namespace_value
+        ENV["REDIS_NAMESPACE"] || ENV["WHIPLASH_CLIENT_ID"]
+      end
+
+    end
+  end
+end

data/lib/whiplash/app/connections.rb

@@ -0,0 +1,57 @@
+module Whiplash
+  module App
+    module Connections
+
+      def app_request(options = {})
+        if options[:params][:id]
+          endpoint = [options[:endpoint], options[:params].delete(:id)].join('/')
+        else
+          endpoint = options[:endpoint]
+        end
+        connection.send(options[:method],
+                        endpoint,
+                        options[:params],
+                        sanitize_headers(options[:headers]))
+      end
+
+      def delete(endpoint, params = {}, headers = nil)
+        app_request(method: :delete,
+                    endpoint: endpoint,
+                    params: params,
+                    headers: headers)
+      end
+
+      def get(endpoint, params = {}, headers = nil)
+        app_request(method: :get,
+                    endpoint: endpoint,
+                    params: params,
+                    headers: headers)
+      end
+
+      def post(endpoint, params = {}, headers = nil)
+        app_request(method: :post,
+                    endpoint: endpoint,
+                    params: params,
+                    headers: headers)
+      end
+
+      def put(endpoint, params = {}, headers = nil)
+        app_request(method: :put,
+                    endpoint: endpoint,
+                    params: params,
+                    headers: headers)
+      end
+
+      def sanitize_headers(headers)
+        if headers
+          {}.tap do |hash|
+            headers.each do |k,v|
+              hash["X-#{k.to_s.upcase.gsub('_','-')}"] = v.to_s
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/whiplash/app/finder_methods.rb

@@ -0,0 +1,30 @@
+module Whiplash
+  module App
+    module FinderMethods
+
+      def count(resource, params = {}, headers = nil)
+        get("#{resource}/count", params, headers).body["count"]
+      end
+
+      def create(resource, params, headers = nil)
+        post("#{resource}", params, headers)
+      end
+
+      def destroy(resource, id, headers = nil)
+        delete("#{resource}", { id: id }, headers)
+      end
+
+      def find(resource, id, headers = nil)
+        get("#{resource}", { id: id }, headers)
+      end
+
+      def find_all(resource, params = {}, headers = nil)
+        get("#{resource}", params, headers)
+      end
+
+      def update(resource, id, params = {}, headers = nil)
+        put("#{resource}", params.merge(id: id), headers)
+      end
+    end
+  end
+end

data/lib/whiplash/app/moneta/namespace.rb

@@ -0,0 +1,45 @@
+module Moneta
+  class Namespace
+    attr_reader :moneta_store
+
+    def initialize store, ns
+      @moneta_store, @ns = store, ns
+    end
+
+    def [] key
+      @moneta_store["#{@ns}:#{key}"]
+    end
+
+    def []= key, value
+      @moneta_store["#{@ns}:#{key}"] = value
+    end
+
+    def delete key
+      @moneta_store.delete "#{@ns}:#{key}"
+    end
+
+    def key? key
+      @moneta_store.key? "#{@ns}:#{key}"
+    end
+
+    def has_key? key
+      @moneta_store.has_key? "#{@ns}:#{key}"
+    end
+
+    def store key, value, options
+      @moneta_store.store "#{@ns}:#{key}", value, options
+    end
+
+    def update_key key, options
+      @moneta_store.update_key "#{@ns}:#{key}", options
+    end
+
+    def clear
+      @moneta_store.clear
+    end
+
+    def method_missing method, args
+      @moneta_store.call method, *args
+    end
+  end
+end

data/lib/whiplash/app/signing.rb

@@ -0,0 +1,22 @@
+module Whiplash
+  module App
+    module Signing
+
+      def request_body(body)
+        body.blank? ? ENV["WHIPLASH_CLIENT_ID"] : body
+      end
+
+      def signature(body)
+        sha256 = OpenSSL::Digest::SHA256.new
+        OpenSSL::HMAC.hexdigest(sha256,
+          ENV["WHIPLASH_CLIENT_SECRET"], request_body(body))
+      end
+
+      def verified?(request)
+        body = request.try(:body).try(:read)
+        request.headers["X-WHIPLASH-SIGNATURE"] == signature(body)
+      end
+
+    end
+  end
+end

data/lib/whiplash/app/version.rb

@@ -0,0 +1,5 @@
+module Whiplash
+  module App
+    VERSION = "0.2.0"
+  end
+end

data/lib/whiplash/app.rb

@@ -0,0 +1,49 @@
+require "whiplash/app/api_config"
+require "whiplash/app/caching"
+require "whiplash/app/connections"
+require "whiplash/app/finder_methods"
+require "whiplash/app/signing"
+require "whiplash/app/version"
+require "oauth2"
+require "faraday_middleware"
+
+module Whiplash
+
+  module App
+    class << self
+      include Whiplash::App::ApiConfig
+      include Whiplash::App::Caching
+      include Whiplash::App::Connections
+      include Whiplash::App::FinderMethods
+      include Whiplash::App::Signing
+
+      attr_accessor :customer_id, :shop_id
+
+      def client
+        OAuth2::Client.new(ENV["WHIPLASH_CLIENT_ID"], ENV["WHIPLASH_CLIENT_SECRET"], site: api_url)
+      end
+
+      def connection
+        out = Faraday.new [api_url, "api/v2"].join("/") do |conn|
+          conn.request :oauth2, token, token_type: "bearer"
+          conn.request :json
+          conn.response :json, :content_type => /\bjson$/
+          conn.use :instrumentation
+          conn.adapter Faraday.default_adapter
+        end
+        return out
+      end
+
+      def refresh_token!
+        oauth_token = client.client_credentials.get_token(scope: ENV["WHIPLASH_CLIENT_SCOPE"])
+        new_token = oauth_token.token
+        cache_store["whiplash_api_token"] = new_token
+      end
+
+      def token
+        refresh_token! unless cache_store["whiplash_api_token"]
+        return cache_store["whiplash_api_token"]
+      end
+    end
+  end
+end

data/whiplash-app.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whiplash/app/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whiplash-app"
+  spec.version       = Whiplash::App::VERSION
+  spec.authors       = ["Don Sullivan, Mark Dickson"]
+  spec.email         = ["developers@getwhiplash.com"]
+
+  spec.summary       = "this gem provides connectivity to the Whiplash API for authentication and REST requests."
+  spec.description   = "this gem provides connectivity to the Whiplash API for authentication and REST requests."
+  spec.homepage      = "https://github.com/whiplashmerch/whiplash-app"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oauth2", "~> 1.2.0"
+  spec.add_dependency "faraday_middleware", "~> 0.10.0"
+  spec.add_dependency "moneta", "~> 0.8.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: whiplash-app
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Don Sullivan, Mark Dickson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: this gem provides connectivity to the Whiplash API for authentication
+  and REST requests.
+email:
+- developers@getwhiplash.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/whiplash/app.rb
+- lib/whiplash/app/api_config.rb
+- lib/whiplash/app/caching.rb
+- lib/whiplash/app/connections.rb
+- lib/whiplash/app/finder_methods.rb
+- lib/whiplash/app/moneta/namespace.rb
+- lib/whiplash/app/signing.rb
+- lib/whiplash/app/version.rb
+- whiplash-app.gemspec
+homepage: https://github.com/whiplashmerch/whiplash-app
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: this gem provides connectivity to the Whiplash API for authentication and
+  REST requests.
+test_files: []
+has_rdoc: