simple_api_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31a920e8c543ee107138c812571ace77aa3a631f
-  data.tar.gz: 7da0b4e707fb83026cfa7891d8182a9f7d28c368
+  metadata.gz: ae96344d08b465b56f54620eb75714d3e61a81e8
+  data.tar.gz: 3a0153a20f2d6ef263f159aa2a1e07e0ce0ed5b2
 SHA512:
-  metadata.gz: 75f5d97afe7bffd0aa05caf6acd4619300f2b494e58cdfbd7c8022a03cc88dd008b0de8a7d496dcb0bd185c41130714b03b09f4222a5554609e936c0147a4a53
-  data.tar.gz: 6ff56c241ce06e7f6f573bf260722cca2521d74ad5997cb9d8a51b54f84dedb8936869a1fde06583e9a989d8ae18d541d3102393b03ddb5ac8751f1cb25cd1a0
+  metadata.gz: 24f3de8ea72890c464e226bcf1135ee44c713d3ca634cca91da41b0a8938c7c56f98db599cc5e5f8978843fbc4e897a55375217ec3f39f200d5c1e05fb0b8c4c
+  data.tar.gz: a2873988e18cbd74008d26b9d85a86210072847996d82919e45f5ddbe066e12683645eb2265a95eb616ed119c71583930c75d5881dd835b27797361f723b99e5

data/Gemfile

@@ -3,9 +3,9 @@ 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'
+group :test, :development do
   gem 'sinatra'
+  gem 'shotgun'
+  gem 'nokogiri'
+  gem 'guard-minitest'
 end

data/README.md

@@ -1,6 +1,6 @@
 # SimpleApiClient
 
-TODO: Write a gem description
+A module to help create api clients quickly. The idea is you shou ld only have to define your endpoints and not worry about setup and the http client.
 
 ## Installation
 
@@ -18,7 +18,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+
+```ruby
+require 'simple_api_client'
+
+class YourClientClass
+
+  include SimpleApiClient
+
+  #including SimpleApiClient gives you a base initialize method that accepts two parameters.
+  #param1: excepts a URI object (which is used to set the Scheme, Host, Port etc, of your api.
+  #param2: is an object that responses to a call method which needs to accept a hash of options.
+
+  #Define your own endpoints
+
+  def client_info(client_id, payload)
+    call(method: :get, uri: uri('/client_info')
+  end
+
+
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -2,7 +2,5 @@ require "bundler/gem_tasks"
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-    t.pattern = "spec/*_spec.rb"
+    t.pattern = "spec/**/*_spec.rb"
 end
-
-

data/config.ru

@@ -1,61 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'json'
-require 'sinatra/base'
-require 'nokogiri'
+#lib = File.expand_path('../lib', __FILE__)
+#$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-class TestingServer < Sinatra::Base
+require 'simple_api_client/testing_server'
 
-  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
+run SimpleApiClient::TestingServer.new

data/lib/simple_api_client/http_caller/{application_types.rb → constants.rb}

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

data/lib/simple_api_client/http_caller/net_http.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+
+module HttpCaller
+  class NetHttp
+
+      # ==== Exceptions
+      # ::Errno::ECONNREFUSED:: - if the server is unresponsive
+      # ::Errno::ECONNRESET:: - the remote host reset the connection request
+      # ::Errno::ETIMEDOUT:: - timed out
+      def call opts
+        accept = HttpCaller::APPLICATION_TYPES[opts.fetch(:accept, :json)]
+        content_type = HttpCaller::APPLICATION_TYPES[opts.fetch(:content_type, :json)]
+
+        http = Net::HTTP.new(opts[:uri].host, opts[:uri].port)
+        case opts[:method]
+        when :post
+          request = Net::HTTP::Post.new(opts[:uri].request_uri)
+          request.body = opts[:payload]
+          request['Content-Type'] = content_type
+        when :get
+          request = Net::HTTP::Get.new(opts[:uri].request_uri)
+        when :put
+          request = Net::HTTP::Put.new(opts[:uri].request_uri)
+          request.body = opts[:payload]
+          request['Content-type'] = content_type
+        else
+          raise ArgumentError.new("Unknown call method: #{opts[:method]}")
+        end
+        request['Accept'] = accept
+        response = http.request(request)
+        Response.new(response.code.to_i, response.body)
+      end
+
+  end
+end

data/lib/simple_api_client/testing_server.rb

@@ -0,0 +1,58 @@
+require 'sinatra/base'
+require 'nokogiri'
+require 'json'
+
+module SimpleApiClient
+  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}
+          output = xml.to_s
+        end
+        halt output
+      end
+      error 406
+    end
+
+  end
+end

data/lib/simple_api_client/version.rb

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

data/lib/simple_api_client.rb

@@ -1,10 +1,8 @@
 require 'simple_api_client/version'
-require 'simple_api_client/http_caller/curb'
+require 'simple_api_client/http_caller/constants'
+require 'simple_api_client/http_caller/net_http'
 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
 

data/simple_api_client.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/dvallance/simple_api_client"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   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"

data/spec/http_caller/{curb_spec.rb → net_http_spec.rb}

@@ -2,7 +2,7 @@ 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
+class NetHttpClient
   include SimpleApiClient
 
   # format can be :json or :xml (defaults to :json)
@@ -35,9 +35,9 @@ class CurbClient
   end
 end
 
-describe HttpCaller::Curb do
+describe HttpCaller::NetHttp do
 
-  subject { CurbClient.new('//127.0.0.1:9393/', HttpCaller::Curb.new) }
+  subject { NetHttpClient.new('//127.0.0.1:9393/', HttpCaller::NetHttp.new) }
 
   it '#call - a get request to /hello_world works when requesting json' do
     result = subject.hello_world(:json)

data/spec/spec_helper.rb

@@ -3,6 +3,5 @@ require 'minitest/autorun'
 require 'minitest/spec'
 require 'minitest/benchmark'
 require 'nokogiri'
-#require 'mocha/mini_test'
-#require 'debugger'
+require 'json'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_api_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dave Vallance
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !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
@@ -82,15 +68,16 @@ files:
 - 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/constants.rb
+- lib/simple_api_client/http_caller/net_http.rb
 - lib/simple_api_client/http_caller/response.rb
+- lib/simple_api_client/testing_server.rb
 - lib/simple_api_client/version.rb
 - simple_api_client.gemspec
-- spec/http_caller/curb_spec.rb
+- spec/http_caller/net_http_spec.rb
 - spec/simple_api_client_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/dvallance/simple_api_client
 licenses:
 - MIT
 metadata: {}
@@ -115,6 +102,6 @@ signing_key:
 specification_version: 4
 summary: A module to help create api clients quickly.
 test_files:
-- spec/http_caller/curb_spec.rb
+- spec/http_caller/net_http_spec.rb
 - spec/simple_api_client_spec.rb
 - spec/spec_helper.rb

data/lib/simple_api_client/http_caller/curb.rb

@@ -1,44 +0,0 @@
-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