simple_api_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31a920e8c543ee107138c812571ace77aa3a631f
+  data.tar.gz: 7da0b4e707fb83026cfa7891d8182a9f7d28c368
+SHA512:
+  metadata.gz: 75f5d97afe7bffd0aa05caf6acd4619300f2b494e58cdfbd7c8022a03cc88dd008b0de8a7d496dcb0bd185c41130714b03b09f4222a5554609e936c0147a4a53
+  data.tar.gz: 6ff56c241ce06e7f6f573bf260722cca2521d74ad5997cb9d8a51b54f84dedb8936869a1fde06583e9a989d8ae18d541d3102393b03ddb5ac8751f1cb25cd1a0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_api_client.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard-minitest'
+  gem 'nokogiri'
+  gem 'shotgun'
+  gem 'sinatra'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest do
+  watch(%r{^spec/(.*)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+  watch(%r{^lib/*}) {'spec'}
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dave Vallance
+
+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,29 @@
+# SimpleApiClient
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_api_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_api_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_api_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,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.pattern = "spec/*_spec.rb"
+end
+
+

data/config.ru

@@ -0,0 +1,61 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json'
+require 'sinatra/base'
+require 'nokogiri'
+
+class TestingServer < Sinatra::Base
+
+  set :raise_errors, true
+
+  get  '/hello_world' do
+    request.accept.each do |type|
+      case type.to_s
+      when 'application/json'
+        output = {greeting: 'Hello World!'}.to_json
+      when 'application/xml'
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.root {
+            xml.greeting {
+              xml << "Hello World!"
+            }
+          }
+        end
+        output = builder.to_xml
+      end
+      halt output
+    end
+    error 406
+  end
+
+  post '/send_data' do
+    put_post_response
+  end
+
+  put '/put' do
+    put_post_response
+  end
+
+  def put_post_response
+    data = request.body.read
+    request.accept.each do |type|
+      case type.to_s
+      when 'application/json'
+        content_type :json
+        #if we get json we can parse it!
+        output = JSON.parse(data).to_json
+      when 'application/xml'
+        content_type :xml
+        #in-valid xml will raise an exception
+        xml = Nokogiri::XML(data){|config| config.strict}
+        puts xml.to_xml
+        output = xml.to_s
+      end
+      halt output
+    end
+    error 406
+  end
+
+end
+
+run TestingServer.new

data/lib/simple_api_client.rb

@@ -0,0 +1,33 @@
+require 'simple_api_client/version'
+require 'simple_api_client/http_caller/curb'
+require 'simple_api_client/http_caller/response'
+require 'simple_api_client/http_caller/application_types'
+require 'active_support/core_ext/module/delegation'
+require 'json'
+
+
+module SimpleApiClient
+
+  ARGUMENT_ERROR_MESSAGE_HOST_MISSING = 'First argument must be a URI object or a URI string that provides a host. (i.e //myhost or http://myhost). Note: Scheme defaults to http if not provided.'
+  ARGUMENT_ERROR_MESSAGE_RESPOND_TO_CALL_NEEDED = 'Second argument must be a class that response_to?(:call).'
+
+  delegate :host, :port, to: :@uri
+  delegate :call, to: :@caller
+  attr_reader :caller
+
+  def initialize uri, api_caller
+    @uri = URI(uri)
+    raise ArgumentError.new(ARGUMENT_ERROR_MESSAGE_HOST_MISSING) if @uri.host.nil?
+    raise ArgumentError.new(ARGUMENT_ERROR_MESSAGE_RESPOND_TO_CALL_NEEDED) unless api_caller.respond_to?(:call)
+    @caller = api_caller
+  end
+
+  def scheme
+    @uri.scheme || 'http'
+  end
+
+  def uri relative_path
+    URI("#{scheme}://#{host}:#{port}#{relative_path}")
+  end
+
+end

data/lib/simple_api_client/http_caller/application_types.rb

@@ -0,0 +1,8 @@
+module HttpCaller
+
+  APPLICATION_TYPES = {
+    json: 'application/json',
+    xml: 'application/xml'
+  }
+
+end

data/lib/simple_api_client/http_caller/curb.rb

@@ -0,0 +1,44 @@
+require 'curb'
+
+module HttpCaller
+  class Curb
+
+    def response http
+      Response.new(http.response_code, http.body_str)
+    end
+
+    def call opts
+      accept = HttpCaller::APPLICATION_TYPES[opts.fetch(:accept, :json)]
+      content_type = HttpCaller::APPLICATION_TYPES[opts.fetch(:content_type, :json)]
+
+      begin
+        case opts[:method]
+        when :post
+          http = Curl.post(opts[:uri].to_s, opts[:payload]) do |http|
+            http.headers['Content-Type'] = content_type
+            http.headers['Accept'] = accept
+          end
+          response(http)
+        when :get
+          http = Curl.get(opts[:uri].to_s) do |http|
+            http.headers['Accept'] = accept
+          end
+          response(http)
+        when :put
+          http = Curl.put(opts[:uri].to_s, opts[:payload]) do |http|
+            http.headers['Content-Type'] = content_type
+            http.headers['Accept'] = accept
+          end
+          response(http)
+        else
+          raise ArgumentError.new("Unknown call method: #{opts[:method]}")
+        end
+      rescue Curl::Err::ConnectionFailedError
+        raise Errno::ECONNREFUSED
+      rescue Curl::Err::TimeoutError
+        raise Errno::ETIMEDOUT
+      end
+    end
+
+  end
+end

data/lib/simple_api_client/http_caller/response.rb

@@ -0,0 +1,4 @@
+module HttpCaller
+  Response = Struct.new(:code, :body)
+end
+

data/lib/simple_api_client/version.rb

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

data/simple_api_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 'simple_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_api_client"
+  spec.version       = SimpleApiClient::VERSION
+  spec.authors       = ["Dave Vallance"]
+  spec.email         = ["davevallance@gmail.com"]
+  spec.summary       = %q{A module to help create api clients quickly.}
+  spec.description   = %q{A module to help create api clients quickly. The idea is you should only have to define your endpoints and not worry about setup and the http client.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'curb'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/http_caller/curb_spec.rb

@@ -0,0 +1,91 @@
+require_relative '../spec_helper'
+
+#NOTE: tests require the server to be running. I use the shotgun gem but any rack server should work just run on port 9393 as its hardcoded below. (A sinatra app is created for these tests in config.ru)
+
+class CurbClient
+  include SimpleApiClient
+
+  # format can be :json or :xml (defaults to :json)
+  def hello_world format
+    call(
+      method: :get,
+      uri: uri('/hello_world'),
+      accept: format
+    )
+  end
+
+  # format can be :json or :xml (defaults to :json)
+  def send_data payload, format
+    call(
+      method: :post,
+      uri: uri('/send_data'),
+      payload: payload,
+      accept: format
+    )
+  end
+
+  # format can be :json or :xml (defaults to :json)
+  def put payload, format
+    call(
+      method: :put,
+      uri: uri('/put'),
+      payload: payload,
+      accept: format
+    )
+  end
+end
+
+describe HttpCaller::Curb do
+
+  subject { CurbClient.new('//127.0.0.1:9393/', HttpCaller::Curb.new) }
+
+  it '#call - a get request to /hello_world works when requesting json' do
+    result = subject.hello_world(:json)
+    JSON.parse(result.body)['greeting'].must_equal 'Hello World!'
+  end
+
+  it '#call - a get request to /hello_world works when requesting xml' do
+    result = subject.hello_world :xml
+    xml = Nokogiri::XML(result.body)
+    xml.at_xpath('//greeting').content.must_equal 'Hello World!'
+  end
+
+  it '#call - a post request to /send_data works when sending json' do
+    put_post_json_test
+  end
+
+  it '#call - a post request to /send_data works when sending xml' do
+    put_post_xml_test
+  end
+
+  it '#call - a put request to /put works when sending json' do
+    put_post_json_test
+  end
+
+  it '#call - a put request to /put works when sending xml' do
+    put_post_xml_test
+  end
+
+  private
+
+  def put_post_json_test
+    data = {"my_data" => "Is very simple"}
+    result = subject.put data.to_json, :json
+    assert JSON.parse(result.body).must_equal data
+  end
+
+  def put_post_xml_test
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.root {
+        xml.data {
+          xml << "My data!"
+        }
+      }
+    end
+
+    result = subject.send_data builder.to_xml, :xml
+    xml = Nokogiri::XML(result.body)
+    xml.at_xpath('//data').content.must_equal 'My data!'
+  end
+
+end

data/spec/simple_api_client_spec.rb

@@ -0,0 +1,55 @@
+require_relative 'spec_helper'
+
+class TestClient
+  include SimpleApiClient
+end
+
+class TestCaller
+  def call(opts)
+  end
+end
+
+describe TestClient do
+
+  it '#initialize expects a valid uri string' do
+    err = proc {
+      TestClient.new(nil, nil)
+    }.must_raise ArgumentError
+
+    assert err.to_s =~ /expected URI/, 'wrong Argument error'
+  end
+
+  it '#initialize expects a valid uri string containg a host' do
+    err = proc {
+      TestClient.new('not_valid', nil)
+    }.must_raise ArgumentError
+
+    err.to_s.must_equal TestClient::ARGUMENT_ERROR_MESSAGE_HOST_MISSING
+  end
+
+  it '#initialize expects a http_client that response to :call' do
+    err = proc {
+     TestClient.new('//www.test.com', nil)
+    }.must_raise ArgumentError
+
+    err.to_s.must_equal TestClient::ARGUMENT_ERROR_MESSAGE_RESPOND_TO_CALL_NEEDED
+  end
+
+  it "#initialize works with valid parameters" do
+    client = TestClient.new("http://127.0.0.1:9393", TestCaller.new)
+    client.scheme.must_equal 'http'
+    client.host.must_equal '127.0.0.1'
+    client.port.must_equal 9393
+  end
+
+  it "#initialize provides a default port of 80 if not supplied in uri" do
+    client = TestClient.new("http://127.0.0.1", TestCaller.new)
+    client.port.must_equal 80
+  end
+
+  it "#initialize provides a default scheme of http if not provided in uri" do
+    client = TestClient.new("//127.0.0.1", TestCaller.new)
+    client.scheme.must_equal 'http'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require_relative '../lib/simple_api_client'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/benchmark'
+require 'nokogiri'
+#require 'mocha/mini_test'
+#require 'debugger'
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: simple_api_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dave Vallance
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-02 00:00:00.000000000 Z
+dependencies:
+- !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: curb
+  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: A module to help create api clients quickly. The idea is you should only
+  have to define your endpoints and not worry about setup and the http client.
+email:
+- davevallance@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.ru
+- lib/simple_api_client.rb
+- lib/simple_api_client/http_caller/application_types.rb
+- lib/simple_api_client/http_caller/curb.rb
+- lib/simple_api_client/http_caller/response.rb
+- lib/simple_api_client/version.rb
+- simple_api_client.gemspec
+- spec/http_caller/curb_spec.rb
+- spec/simple_api_client_spec.rb
+- spec/spec_helper.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.2.2
+signing_key: 
+specification_version: 4
+summary: A module to help create api clients quickly.
+test_files:
+- spec/http_caller/curb_spec.rb
+- spec/simple_api_client_spec.rb
+- spec/spec_helper.rb