reverb-service-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18035f451800fb0b77df7989ef400e556e8b6d6d
+  data.tar.gz: 18b4d640f5e72c5b25138ae39a1e8f8d461d044d
+SHA512:
+  metadata.gz: c81dc9da01df6b6dd8213fad775c0f862547679f872120f90c6ba14b1d25742dc70ee188e8f25f3a25eca9a26d86b00111431155b04c30968a5eb97d92cdb070
+  data.tar.gz: 801ed6f8b4c0fad2c69cf13a2a759cc7510525a981124ea223a48381b8188541410d5da875f27dbdbd004d43bf11a138547937196168eea28bb8cd890d411915

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in service-client.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yan Pritzker
+
+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,45 @@
+# Reverb::Service::Client
+
+A base class for clients of Reverb services. Provides basic abstraction over http.
+
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+    gem 'reverb-service-client'
+
+Require it
+
+    require 'reverb/service/client'
+
+Inherit from Reverb::Service::Client in your client:
+
+    class MyClient < Reverb::Service::Client
+    end
+
+Set up your client with the service url:
+
+    client = MyClient.new("http://localhost:9292")
+
+You get all the http verbs as methods, plus a `parse` method that will give you a Hash parsed from JSON:
+
+    class MyClient < Reverb::Service::Client
+      def get_some_stuff
+        parse get("/foo", {bar: 'baz'})
+      end
+    end
+
+If the service is down, this will throw an error:
+
+    Reverb::Service::Client::ServiceUnavailableError
+
+That's all (for now).
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/reverb/service/client.rb

@@ -0,0 +1,76 @@
+require "typhoeus"
+require "json"
+require 'active_support/all'
+require 'pp'
+
+require "reverb/service/client/version"
+
+module Reverb
+  module Service
+    class Client
+      class ServiceUnavailableError < RuntimeError; end
+      class BadResponseError < RuntimeError; end
+      class NotFoundError < RuntimeError; end
+
+      def initialize(service_url, timeout: 5)
+        @service_url = service_url
+        @timeout = timeout
+      end
+
+      protected
+
+      def put(endpoint, body={})
+        request(endpoint, 'PUT', body)
+      end
+
+      def get(endpoint, params={})
+        request(endpoint_with_params(endpoint, params), 'GET')
+      end
+
+      def post(endpoint, body)
+        request(endpoint, 'POST', body)
+      end
+
+      def delete(endpoint, params={})
+        request(endpoint_with_params(endpoint, params), 'DELETE')
+      end
+
+      def parse(response)
+        return {} if response.body.empty?
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        raise Reverb::Service::Client::BadResponseError, "Expected a JSON response. Status: #{response.code} Body:#{response.body}"
+      end
+
+      def request(endpoint, method, body=nil)
+        request = Typhoeus::Request.new("#{@service_url}/#{endpoint}", {
+          method: method,
+          timeout: @timeout,
+          body: body.to_json,
+          forbid_reuse: true, # do not re-use connections in libcurl
+          followlocation: true,
+          maxredirs: 3, # only follow 3 redirects
+          headers: {
+            'Content-Type' => "application/hal+json"
+          }
+        })
+
+        request.on_complete do |response|
+          if response.timed_out?
+            raise Reverb::Service::Client::ServiceUnavailableError, response.pretty_inspect
+          end
+        end
+
+        request.run
+      end
+
+      def endpoint_with_params(endpoint, params)
+        if !params.empty?
+          "#{endpoint}?#{params.to_param}"
+        else
+          endpoint
+        end
+      end
+    end
+  end
+end

data/lib/reverb/service/client/version.rb

@@ -0,0 +1,7 @@
+module Reverb
+  module Service
+    class Client
+      VERSION = "0.1.0"
+    end
+  end
+end

data/service-client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reverb/service/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reverb-service-client"
+  spec.version       = Reverb::Service::Client::VERSION
+  spec.authors       = ["Yan Pritzker"]
+  spec.email         = ["yan@reverb.com"]
+  spec.description   = %q{Base for http service clients}
+  spec.summary       = %q{}
+  spec.homepage      = ""
+  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 "typhoeus"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/client_spec.rb

@@ -0,0 +1,77 @@
+require 'reverb/service/client'
+require 'webmock/rspec'
+
+describe Reverb::Service::Client do
+  let(:url) { "http://some.url"}
+  let(:url_with_params) { "#{url}/foo?bar=baz" }
+
+  class MyClient < Reverb::Service::Client
+    def get_test
+      parse get("foo", bar: 'baz')
+    end
+
+    def post_test
+      post("foo", {bar: "baz"})
+    end
+
+    def delete_test
+      delete("foo", bar: "baz")
+    end
+
+    def put_test
+      parse put("foo", {bar: "baz"})
+    end
+  end
+
+  let(:client) { MyClient.new(url) }
+
+  it "executes GET requests" do
+    stub_request(:GET, url_with_params).to_return(status: 200, body: "{}")
+    client.get_test
+  end
+
+  it "executes PUT requests" do
+    stub_request(:PUT, "http://some.url/foo").to_return(status: 200, body: "{}")
+    client.put_test
+  end
+
+  it "executes DELETE requests" do
+    stub_request(:DELETE, url_with_params).to_return(status: 200, body: "{}")
+    client.delete_test
+  end
+
+  context "when the response is empty" do
+    before do
+      stub_request(:GET, url_with_params).to_return(status: 404, body: "")
+    end
+
+    specify do
+      client.get_test.should == {}
+    end
+  end
+
+  context "when there is a problem parsing the response" do
+    before do
+      stub_request(:GET, url_with_params).to_return(status: 500, body: "Not json!")
+    end
+
+    specify do
+      expect { client.get_test }.to raise_error(Reverb::Service::Client::BadResponseError)
+    end
+  end
+
+  context "when the service is down" do
+    before do
+      stub_request(:GET, url_with_params).to_timeout
+    end
+
+    it "raises a ServiceUnavailableError with typhoeus debugging output as the message" do
+      begin
+        client.get_test
+      rescue Reverb::Service::Client::ServiceUnavailableError => e
+        e.message.should be_present
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: reverb-service-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yan Pritzker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  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: 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'
+description: Base for http service clients
+email:
+- yan@reverb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reverb/service/client.rb
+- lib/reverb/service/client/version.rb
+- service-client.gemspec
+- spec/client_spec.rb
+homepage: ''
+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.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/client_spec.rb