crud_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e76e667bdd01448e65e8d85fff7f9fb48f4df73
+  data.tar.gz: 82c83138d330436b34aae68ac642c9de2f9956a6
+SHA512:
+  metadata.gz: 893132684feebb1ea998d4c2db851bdf3638379088bcdfd773b94a798d4a3d6f49cc1320dbca88dd3a04bd9ebb8ab86f98e9ffb4af0fdc39cef243e031687666
+  data.tar.gz: f95829a325a9a73dd800b6672380c48d480e496b97d03488c88ca51984bcb863133c71e98b539bbd5a55295fa7f03142ffd147d069d2e515d553d87caef8c732

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+crud-client

data/.ruby-version

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jay OConnor
+
+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,35 @@
+# CrudClient
+Easy-ish API management for use with Napa
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crud_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crud_client
+
+## Usage
+
+Define the following ENV variables for best results
+```
+SERVICE_NAME
+RACK_ENV
+HEADER_PASSWORD
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/crud_client/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/crud_client.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/crud_client/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "crud_client"
+  spec.version       = CrudClient::VERSION
+  spec.authors       = ["Jay OConnor"]
+  spec.email         = ["jay@bellycard.com"]
+  spec.description   = %q{Easy connections to APIs}
+  spec.summary       = %q{Easy connections to APIs}
+  spec.homepage      = ""
+  spec.license       = ""
+
+  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'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'celluloid'
+  spec.add_dependency 'celluloid-io'
+  spec.add_dependency 'imprint'
+  spec.add_dependency 'napa'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'git'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/crud_client/crud_client.rb

@@ -0,0 +1,107 @@
+require 'ostruct'
+require 'active_support/all'
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
+require 'celluloid/io'
+require 'imprint'
+require 'napa'
+
+module CrudClient
+  class CrudClient
+    include Celluloid::IO
+    cattr_accessor :trace_id
+
+    def self.get(*args)
+      request = Request.new(*args)
+      issue_request(:get, "#{request_url}/#{request.id}", request.options)
+    end
+    self.singleton_class.send(:alias_method, :index, :get)
+    self.singleton_class.send(:alias_method, :show, :get)
+
+    def self.post(*args)
+      request = Request.new(*args)
+      issue_request(:post, "#{request_url}/#{request.id}", request.options)
+    end
+    self.singleton_class.send(:alias_method, :create, :post)
+
+    def self.put(*args)
+      request = Request.new(*args)
+      issue_request(:put, "#{request_url}/#{request.id}", request.options)
+    end
+    self.singleton_class.send(:alias_method, :update, :put)
+
+    def self.delete(*args)
+      request = Request.new(*args)
+      issue_request(:delete, "#{request_url}/#{request.id}", request.options)
+    end
+    self.singleton_class.send(:alias_method, :destroy, :delete)
+
+    def self.request_url
+      "#{base_url}/#{name.demodulize.underscore.pluralize}"
+    end
+
+    def self.base_url
+      url = ENV["#{name.split('::')[0].underscore.upcase}_URL"]
+      url ||= default_base_url
+      url
+    end
+
+    def self.issue_request(method, url, options)
+      raise "HEADER_PASSWORD Environment Variable is not set." if ENV['HEADER_PASSWORD'].nil? && ENV['RACK_ENV'] != 'test'
+
+      self.trace_id = Imprint::Tracer.get_trace_id.to_s.dup
+
+      # use a new celluloid actor thread
+      future = Celluloid::Future.new do
+        begin
+          logger = defined?(Rails) ? Rails.logger : Napa::Logger.logger
+          logger.info("#{ENV['SERVICE_NAME']} is calling #{self.name}")
+          response = conn.send(method, url, options) do |request|
+            request.headers = request.headers.merge(headers)
+          end
+          to_return_type response.body
+        rescue => e
+          # Throw this to honeybadger with a context of what's going on if it is defined.
+          Honeybadger.notify(e, context: { method: method,
+                                           url: url,
+                                           options: options,
+                                           response_status: response.try(:status),
+                                           response_body: response.try(:body) }) if defined?(Honeybadger)
+          # re-raise the error
+          raise e
+        end
+      end
+      future.extend(FutureWrapper)
+    end
+
+    def self.to_return_type response_body
+      # attempt to parse json and mashify it here to catch errors better
+      Hashie::Mash.new(JSON.parse(response_body))
+    end
+
+    def self.conn
+      connection = Faraday.new do |conn|
+        conn.request :json
+        conn.adapter  Faraday.default_adapter
+      end
+      connection
+    end
+
+    def issue_request(method, url, options)
+      self.class.issue_request(method, url, options)
+    end
+
+    def self.headers
+      {
+        'Password' => ENV['HEADER_PASSWORD'],
+        'X_B3_TRACEID' => trace_id,
+        'User-Agent' => "#{Napa::Identity.name}/#{Napa::Identity.revision}"
+      }
+    end
+
+    def self.production?
+      (ENV['RAILS_ENV'] || ENV['RACK_ENV']) == 'production'
+    end
+  end
+end

data/lib/crud_client/future_wrapper.rb

@@ -0,0 +1,11 @@
+module CrudClient
+  module FutureWrapper
+    def[](key)
+      value[key]
+    end
+
+    def method_missing(sym, *args, &block)
+      value.send sym, *args, &block
+    end
+  end
+end

data/lib/crud_client/request.rb

@@ -0,0 +1,19 @@
+module CrudClient
+  class Request
+    attr_reader :id
+
+    def initialize(*args)
+      @args = *args
+      @id   = extract_id
+    end
+
+    def options
+      @args.any? ? @args.first.to_hash : {}
+    end
+
+    private
+      def extract_id
+        @args.shift unless @args.first.is_a?(Hash)
+      end
+  end
+end

data/lib/crud_client/version.rb

@@ -0,0 +1,3 @@
+module CrudClient
+  VERSION = "0.0.1"
+end

data/lib/crud_client.rb

@@ -0,0 +1,8 @@
+require 'crud_client/version'
+require 'crud_client/crud_client'
+require 'crud_client/request'
+require 'crud_client/future_wrapper'
+
+module CrudClient
+  require 'init'
+end

data/lib/init.rb

@@ -0,0 +1 @@
+Kernel::silence_warnings { Imprint::Tracer.const_set('TRACER_HEADER', 'HTTP_X_B3_TRACEID') }

data/spec/crud_client_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'crud_client/crud_client'
+
+class PapaFake
+end
+class PapaFake::FakeService < CrudClient::CrudClient
+end
+
+module Imprint
+  class Tracer
+    def self.get_trace_id
+      'some-trace-id'
+    end
+  end
+end
+
+describe CrudClient::CrudClient do
+  ENV['PAPA_FAKE_URL'] = "http://localhost:9292"
+  ENV['SERVICE_NAME'] = "fake-service"
+  context 'when making class level requests' do
+    it 'performs a get' do
+      PapaFake::FakeService.should_receive(:issue_request){ |method, url, options|
+        expect(method).to eq(:get)
+        expect(url).to eq("http://localhost:9292/fake_services/1")
+      }.and_return('{}')
+      PapaFake::FakeService.get("1")
+    end
+
+    it 'performs a show (get)' do
+      PapaFake::FakeService.should_receive(:issue_request){ |method, url, options|
+        expect(method).to eq(:get)
+        expect(url).to eq("http://localhost:9292/fake_services/1")
+      }.and_return('{}')
+      PapaFake::FakeService.show("1")
+    end
+
+    it 'performs an arbitrary call' do
+      PapaFake::FakeService.should_receive(:issue_request){ |method, url, options|
+        expect(method).to eq(:get)
+        expect(url).to eq("http://localhost:9292/fake_services/cookie")
+      }.and_return('{}')
+      PapaFake::FakeService.get("cookie")
+    end
+
+    context 'when the get request contains a hash' do
+      it 'performs an index' do
+        PapaFake::FakeService.should_receive(:issue_request){ |method, url, options|
+          expect(method).to eq(:get)
+          expect(url).to eq("http://localhost:9292/fake_services/")
+          expect(options).to eq({ foo: 'bar' })
+        }.and_return('{}')
+        PapaFake::FakeService.get(foo: 'bar')
+      end
+    end
+
+    context 'when the get request contains nothing' do
+      it 'performs an index' do
+        PapaFake::FakeService.should_receive(:issue_request){ |method, url, options|
+          expect(method).to eq(:get)
+          expect(url).to eq("http://localhost:9292/fake_services/")
+          expect(options).to eq({})
+        }.and_return('{}')
+        PapaFake::FakeService.get
+      end
+    end
+
+    it 'performs a post' do
+      PapaFake::FakeService.should_receive(:issue_request){ |method, url, options|
+        expect(method).to eq(:post)
+        expect(url).to eq("http://localhost:9292/fake_services/")
+        expect(options).to eq({ foo: 'bar' })
+      }.and_return('{}')
+      PapaFake::FakeService.post(foo: 'bar')
+    end
+
+    it 'performs a put' do
+      PapaFake::FakeService.should_receive(:issue_request){ |method, url, options|
+        expect(method).to eq(:put)
+        expect(url).to eq("http://localhost:9292/fake_services/1")
+        expect(options).to eq({ foo: 'bar' })
+      }.and_return('{}')
+      PapaFake::FakeService.put("1", foo: 'bar')
+    end
+
+    it 'performs a delete' do
+      PapaFake::FakeService.should_receive(:issue_request){ |method, url, options|
+        expect(method).to eq(:delete)
+        expect(url).to eq("http://localhost:9292/fake_services/1")
+        expect(options).to eq({ foo: 'bar' })
+      }.and_return('{}')
+      PapaFake::FakeService.delete("1", foo: 'bar')
+    end
+
+    it 'adds a tracer bullet to the request' do
+      PapaFake::FakeService.issue_request(:get, '/', {})
+      expect(PapaFake::FakeService.headers['X_B3_TRACEID'].empty?).to_not be true
+    end
+
+    it 'adds a User-Agent header to the request' do
+      PapaFake::FakeService.issue_request(:get, '/', {})
+      expect(PapaFake::FakeService.headers['User-Agent']).to include(ENV['SERVICE_NAME'])
+      expect(PapaFake::FakeService.headers['User-Agent']).to match(/\/.+\z/)
+    end
+  end
+end

data/spec/init_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Initialization' do
+  it 'Overrides the values of TRACER_HEADER in the Imprint gem' do
+    expect(Imprint::Tracer::TRACER_HEADER).to eq('HTTP_X_B3_TRACEID')
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'crud_client/request'
+
+describe CrudClient::Request do
+  describe '#extract_id' do
+    it 'returns the id if the first arg is not a hash' do
+      request = CrudClient::Request.new(123, {foo: 'bar', bar: 'baz'})
+      expect(request.id).to eq(123)
+    end
+
+    it 'returns nil if the first arg is hash' do
+      request = CrudClient::Request.new({foo: 'bar', bar: 'baz'})
+      expect(request.id).to be_nil
+    end
+  end
+
+  describe '#options' do
+    it 'returns a hash of options if supplied' do
+      request = CrudClient::Request.new({foo: 'bar', bar: 'baz'})
+      expect(request.options.class).to be(Hash)
+      expect(request.options[:foo]).to eq('bar')
+      expect(request.options[:bar]).to eq('baz')
+    end
+
+    it 'returns an empty hash if no options are supplied' do
+      request = CrudClient::Request.new()
+      expect(request.options.class).to be(Hash)
+      expect(request.options).to eq({})
+    end
+
+    it 'returns an empty hash if only an id is supplied' do
+      request = CrudClient::Request.new(123)
+      expect(request.options.class).to be(Hash)
+      expect(request.options).to eq({})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'pry'
+require 'simplecov'
+ENV['RACK_ENV'] = 'test'
+SimpleCov.start do
+  add_filter "/spec\/.*/"
+end
+require 'crud_client'

metadata

@@ -0,0 +1,290 @@
+--- !ruby/object:Gem::Specification
+name: crud_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jay OConnor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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: hashie
+  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: activesupport
+  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: celluloid
+  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: celluloid-io
+  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: imprint
+  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: napa
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: git
+  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: rubocop
+  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: guard-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: simplecov
+  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'
+description: Easy connections to APIs
+email:
+- jay@bellycard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- crud_client.gemspec
+- lib/crud_client.rb
+- lib/crud_client/crud_client.rb
+- lib/crud_client/future_wrapper.rb
+- lib/crud_client/request.rb
+- lib/crud_client/version.rb
+- lib/init.rb
+- spec/crud_client_spec.rb
+- spec/init_spec.rb
+- spec/request_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Easy connections to APIs
+test_files:
+- spec/crud_client_spec.rb
+- spec/init_spec.rb
+- spec/request_spec.rb
+- spec/spec_helper.rb