message_exchange 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e413293bee6021a29b2b4c73e217d24fe5046c34
+  data.tar.gz: 4bacba899d4d70ba5f1b1d0a69e51f17fd41f5c2
+SHA512:
+  metadata.gz: 6aab063ac0ddbc02090912b39c72e5c86fd016daa0731078d71867cdd60a970adb4b07fa926597a862529e2c74f3332e945d41d345cb2633d3038ead45aec33a
+  data.tar.gz: 78c6c07527d5ba8f021a652ade115091e7796b45fd065ae30c2b5106a52bb4b0defeb03299396e2d201874df9e56a22e191467ceb39a589ac9634c4ba07cf762

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/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 On The Beach 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,50 @@
+# MessageExchange [![Code Climate](https://codeclimate.com/github/onthebeach/message_exchange.png)](https://codeclimate.com/github/onthebeach/message_exchange) [![Build Status](https://travis-ci.org/onthebeach/message_exchange.png?branch=master)](https://travis-ci.org/onthebeach/message_exchange)
+
+Use MessageExchange to simplify the passing of JSON-based messages between HTTP based applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'message_exchange', git: 'git@github.com:onthebeach/message_exchange.git'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install message_exchange
+
+## Usage
+
+Craft your request, replacing the class with one of `Get`, `Post`, `Put` or `Delete`.
+
+    request = MessageExchange::Get.new(url_string, params_hash)
+
+Consume the response:
+
+    response = request.response
+
+    response.status # => the HTTP response code
+
+    response.success? # => Boolean (based on 20x response code)
+
+    response.body # => some stuff you probably wanted
+
+## Todo
+
+* Implement other HTTP v1.1 methods: `Patch`, `Options`, `Head`, `Trace` or `Connect`.
+* Better error handling; currently only catches request timeouts.
+* Configurable timeouts.
+* Configurable headers.
+* Configurable ports (instead of just port 80).
+* HTTP/HTTPS support.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("./Rakefile", __FILE__)
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'lib/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new
+task :default => :spec
+

data/lib/message_exchange.rb

@@ -0,0 +1,13 @@
+require "net/http"
+require "yajl"
+require "active_support/core_ext"
+
+require "message_exchange/version"
+
+require "message_exchange/response"
+require "message_exchange/server_error_response"
+require "message_exchange/request"
+require "message_exchange/get"
+require "message_exchange/delete"
+require "message_exchange/post"
+require "message_exchange/put"

data/lib/message_exchange/delete.rb

@@ -0,0 +1,13 @@
+module MessageExchange
+  class Delete < Request
+    def request
+      Net::HTTP::Delete.new(full_path).tap do |request|
+        request['Accept'] = 'application/json'
+      end
+    end
+
+    def full_path
+      uri.request_uri
+    end
+  end
+end

data/lib/message_exchange/get.rb

@@ -0,0 +1,18 @@
+module MessageExchange
+  class Get < Request
+    def request
+      Net::HTTP::Get.new(full_path).tap do |request|
+        request['Accept'] = 'application/json'
+      end
+    end
+
+    def full_path
+      "#{uri.request_uri}#{parameter_string}"
+    end
+
+    def parameter_string
+      return ("?" + params.to_query) unless params.empty?
+      ""
+    end
+  end
+end

data/lib/message_exchange/post.rb

@@ -0,0 +1,14 @@
+module MessageExchange
+  class Post < Request
+    def request
+      Net::HTTP::Post.new(full_path).tap do |request|
+        request['Accept'] = 'application/json'
+        request.body = params.to_param
+      end
+    end
+
+    def full_path
+      uri.request_uri
+    end
+  end
+end

data/lib/message_exchange/put.rb

@@ -0,0 +1,14 @@
+module MessageExchange
+  class Put < Request
+    def request
+      Net::HTTP::Put.new(full_path).tap do |request|
+        request['Accept'] = 'application/json'
+        request.body = params.to_param
+      end
+    end
+
+    def full_path
+      uri.request_uri
+    end
+  end
+end

data/lib/message_exchange/request.rb

@@ -0,0 +1,31 @@
+module MessageExchange
+  class Request
+    attr_reader :uri, :params
+
+    def initialize(uri, params = {})
+      @uri    = URI(uri)
+      @params = params
+    end
+
+    def request
+      raise NotImplementedError, "Subclasses must implement this"
+    end
+
+    def port
+      80
+    end
+
+    def response
+      @response ||= Response.new(http.request(request))
+    rescue Timeout::Error
+      @response ||= ServerErrorResponse.new
+    end
+
+    def http
+      Net::HTTP.new(uri.host, port).tap do |http|
+        http.open_timeout = 0.1
+        http.read_timeout = 0.5
+      end
+    end
+  end
+end

data/lib/message_exchange/response.rb

@@ -0,0 +1,25 @@
+module MessageExchange
+  class Response
+    attr_accessor :status, :body
+
+    def initialize(api_response)
+      @api_response = api_response
+    end
+
+    def status
+      @status ||= api_response.code.to_i
+    end
+
+    def body
+      @body ||= Yajl::Parser.parse(api_response.body)
+    end
+
+    def success?
+      (200..206).include?(status)
+    end
+
+    private
+
+    attr_reader :api_response
+  end
+end

data/lib/message_exchange/server_error_response.rb

@@ -0,0 +1,15 @@
+module MessageExchange
+  class ServerErrorResponse
+    def status
+      500
+    end
+
+    def body
+      '{ "error": "Request timed out." }'
+    end
+
+    def success?
+      false
+    end
+  end
+end

data/lib/message_exchange/version.rb

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

data/message_exchange.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'message_exchange/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "message_exchange"
+  spec.version       = MessageExchange::VERSION
+  spec.authors       = ["Gavin Laking", "Salla Turunen"]
+  spec.email         = ["gavin.laking@onthebeach.co.uk", "salla.turunen@onthebeach.co.uk"]
+  spec.description   = %q{Gem to facilitate HTTP request/responses between applications.}
+  spec.summary       = spec.description
+  spec.homepage      = "http://www.onthebeach.co.uk/"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "activesupport", "3.2.13"
+  spec.add_dependency "yajl-ruby"
+end

data/spec/lib/message_exchange/delete_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe MessageExchange::Delete do
+  subject { described_class.new('http://www.myurl.woo') }
+
+  it "makes a request to a URL" do
+    stub_request(:delete, "http://www.myurl.woo/").
+      with(:headers => {'Accept'=>'application/json'})
+
+    subject.response
+  end
+
+  it "returns a ServerErrorResponse when the request times out" do
+    Net::HTTP.stub(:new){ raise Timeout::Error }
+
+    expect(subject.response).to be_a MessageExchange::ServerErrorResponse
+  end
+end

data/spec/lib/message_exchange/get_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe MessageExchange::Get do
+  subject { described_class.new('http://www.myurl.woo') }
+
+  it "makes a request to a URL" do
+    stub_request(:get, "http://www.myurl.woo/").
+         with(:headers => {'Accept'=>'application/json'}).
+         to_return(:status => 200, :body => "", :headers => {})
+    subject.response
+  end
+
+  it "passes the parameters that we configure" do
+    stub_request(:get, "http://www.myurl.woo/?foo=bar").
+      with(:headers => {'Accept'=>'application/json'})
+
+    described_class.new('http://www.myurl.woo', {:foo => 'bar'}).response
+  end
+
+  it "returns a ServerErrorResponse when the request times out" do
+    Net::HTTP.stub(:new){ raise Timeout::Error }
+
+    expect(subject.response).to be_a MessageExchange::ServerErrorResponse
+  end
+
+  it "does not return a parameter string if there are no parameters" do
+    expect(subject.parameter_string).to_not include("?")
+  end
+end

data/spec/lib/message_exchange/post_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe MessageExchange::Post do
+  subject { described_class.new('http://www.myurl.woo') }
+
+  it "makes a request to a URL" do
+    stub_request(:post, "http://www.myurl.woo/").
+      with(:headers => {'Accept'=>'application/json'})
+
+    subject.response
+  end
+
+  it "returns a ServerErrorResponse when the request times out" do
+    Net::HTTP.stub(:new){ raise Timeout::Error }
+
+    expect(subject.response).to be_a MessageExchange::ServerErrorResponse
+  end
+end

data/spec/lib/message_exchange/put_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe MessageExchange::Put do
+  subject { described_class.new('http://www.myurl.woo') }
+
+  it "makes a request to a URL" do
+    stub_request(:put, "http://www.myurl.woo/").
+      with(:headers => {'Accept'=>'application/json'})
+
+    subject.response
+  end
+
+  it "returns a ServerErrorResponse when the request times out" do
+    Net::HTTP.stub(:new){ raise Timeout::Error }
+
+    expect(subject.response).to be_a MessageExchange::ServerErrorResponse
+  end
+end

data/spec/lib/message_exchange/request_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe MessageExchange::Request do
+  let(:uri)    { "http://www.myurl.woo/" }
+
+  describe "#request" do
+    subject { described_class.new(uri).request }
+
+    it "raises the not implemented error" do
+      expect{ subject }.to raise_error(NotImplementedError, "Subclasses must implement this")
+    end 
+  end
+
+  describe "#port" do
+    subject { described_class.new(uri).port }
+
+    it "sets the port to 80" do
+      expect(subject).to eq(80)
+    end
+  end
+end

data/spec/lib/message_exchange/response_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe MessageExchange::Response do
+	let(:api_response) { double(:api_response) }
+
+	describe "#status" do
+		subject { described_class.new(api_response).status }
+
+		before do
+			api_response.stub(:code) { "200" }
+		end
+
+		it "returns the status code of the response" do
+			expect(subject).to eq(200)
+		end
+	end
+
+	describe "#body" do
+		subject { described_class.new(api_response).body }
+
+		before do
+			api_response.stub(:body) { "{\"string\": \"Hello World\"}" }
+		end
+
+		it "returns the parsed JSON body" do
+			expect(subject).to eq({"string" => "Hello World"})
+		end
+	end
+
+	describe "#success?" do
+		subject { described_class.new(api_response).success? }
+
+		(200..206).map(&:to_s).each do |code|
+			context "when #{code}" do
+				before do
+					api_response.stub(:code) { code }
+				end
+
+				it { expect(subject).to be_true }
+			end
+		end
+
+		context "when the status code is not 20x" do
+			before do 
+				api_response.stub(:code) { 301 }
+			end
+
+			it "returns a false" do
+				expect(subject).to be_false
+			end
+		end
+	end
+end

data/spec/lib/message_exchange/server_error_response_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe MessageExchange::ServerErrorResponse do
+  describe "#status" do
+    subject { described_class.new.status }
+
+    it { subject.should eq(500) }
+  end
+
+  describe "#body" do
+    subject { described_class.new.body }
+
+    it { subject.should eq('{ "error": "Request timed out." }') }
+  end
+
+  describe "#success?" do
+    subject { described_class.new.success? }
+
+    it { subject.should be_false }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+
+SimpleCov.start
+
+require "webmock/rspec"
+require "message_exchange"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: message_exchange
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gavin Laking
+- Salla Turunen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-04 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  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'
+description: Gem to facilitate HTTP request/responses between applications.
+email:
+- gavin.laking@onthebeach.co.uk
+- salla.turunen@onthebeach.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/message_exchange.rb
+- lib/message_exchange/delete.rb
+- lib/message_exchange/get.rb
+- lib/message_exchange/post.rb
+- lib/message_exchange/put.rb
+- lib/message_exchange/request.rb
+- lib/message_exchange/response.rb
+- lib/message_exchange/server_error_response.rb
+- lib/message_exchange/version.rb
+- message_exchange.gemspec
+- spec/lib/message_exchange/delete_spec.rb
+- spec/lib/message_exchange/get_spec.rb
+- spec/lib/message_exchange/post_spec.rb
+- spec/lib/message_exchange/put_spec.rb
+- spec/lib/message_exchange/request_spec.rb
+- spec/lib/message_exchange/response_spec.rb
+- spec/lib/message_exchange/server_error_response_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.onthebeach.co.uk/
+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.3
+signing_key: 
+specification_version: 4
+summary: Gem to facilitate HTTP request/responses between applications.
+test_files:
+- spec/lib/message_exchange/delete_spec.rb
+- spec/lib/message_exchange/get_spec.rb
+- spec/lib/message_exchange/post_spec.rb
+- spec/lib/message_exchange/put_spec.rb
+- spec/lib/message_exchange/request_spec.rb
+- spec/lib/message_exchange/response_spec.rb
+- spec/lib/message_exchange/server_error_response_spec.rb
+- spec/spec_helper.rb