optimis_client 0.2.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    optimis_client (0.2.0)
+      typhoeus (~> 0.2.3)
+      yajl-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    mime-types (1.16)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    typhoeus (0.2.4)
+      mime-types
+      mime-types
+    yajl-ruby (0.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  optimis_client!
+  rspec (~> 2.5)

data/README.md

@@ -0,0 +1,35 @@
+# Optimis Client
+
+a Ruby client library for Optimis Service
+
+## Requirements
+
+* typhoeus
+* yajl-ruby
+
+### typhoeus requires libcurl >= 7.19 with OpenSSL support
+
+    wget http://curl.haxx.se/download/curl-7.21.6.tar.gz
+    tar zxvf curl-7.21.6.tar.gz
+    cd curl-7.21.6
+    ./configure --with-ssl
+    make
+    make install
+    gem install typhoeus
+
+## Run Unit Test
+
+	bundle exec rspec spec/lib
+  
+## Design Note
+
+As a client library, it should support:
+
+* Wrap typhoeus operation
+* Secure connection
+* Handle timeout
+* Provide 'stubbed' option, it will stub return values if set true
+
+It will not:
+
+* Rescue exception, it will raise to application layer.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/optimis_client/base.rb

@@ -0,0 +1,88 @@
+module OptimisClient
+
+  class ResponseError < StandardError
+    attr_accessor :status, :message, :errors
+    
+    def initialize(http_status, message=nil, errors = {})
+      self.status, self.message, self.errors = http_status, message, errors
+    end
+  end
+  
+  class Base
+    
+    DEFAULT_TIMEOUT = 10*1000 # 10s
+
+    @@hydra = Typhoeus::Hydra.new
+    
+    class << self
+      attr_accessor :host, :secure, :api_key, :timeout
+        
+      def hydra
+        @@hydra
+      end
+      
+      def stubbed?
+        !!@stubbed
+      end
+      
+      def stubbed=(value)
+        @stubbed = value
+      end
+            
+      def secure=(value, disable_ssl_peer_verification = true)
+        if value && !(Typhoeus::Easy.new.curl_version =~ /OpenSSL/)
+          raise "Your libcurl SSL support not enabled." 
+        end
+        @secure = value
+        @disable_ssl_peer_verification = disable_ssl_peer_verification
+      end
+                  
+      def http_protocol
+        (self.secure)? "https://" : "http://"
+      end
+      
+      def hydra_run_all
+        self.hydra.run unless self.stubbed?
+      end
+
+      protected
+
+      def new_request(url, options={})
+        options = { :disable_ssl_peer_verification => @disable_ssl_peer_verification, 
+                    :timeout => (@timeout || DEFAULT_TIMEOUT) }.merge(options)
+         
+        options[:params] ||= {}           
+        options[:params].merge!( :api_key => self.api_key ) unless options[:params][:api_key]
+                             
+        options[:headers] ||= {}
+        options[:headers].merge!( "Authorization" => self.api_key ) unless options[:headers][:api_key]
+         
+        Typhoeus::Request.new(url, options)
+      end
+      
+      def parse_json(response)
+        begin
+          Yajl::Parser.parse(response.body)
+        rescue
+          raise ResponseError.new( 502, "Parsing service JSON error: #{response.body}")
+        end
+      end
+      
+      def hydra_run(request)   
+        self.hydra.queue(request)
+        self.hydra.run
+        response = request.response
+
+        if response.timed_out?
+          # response.curl_return_code => 28
+          # http://curl.haxx.se/libcurl/c/libcurl-errors.html
+          raise ResponseError.new( 504, "Service Timeout")
+        else
+          return response
+        end
+      end
+            
+    end
+  end
+  
+end

data/lib/optimis_client/version.rb

@@ -0,0 +1,3 @@
+module OptimisClient
+  VERSION = "0.2.0"
+end

data/lib/optimis_client.rb

@@ -0,0 +1,3 @@
+require 'typhoeus'
+require "yajl"
+require File.join(File.dirname(__FILE__), 'optimis_client/base')

data/optimis_client.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "optimis_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "optimis_client"
+  s.version     = OptimisClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OptimisDev Taipei Team"]
+  s.email       = ["devteam-tw@optimiscorp.com"]
+  s.homepage    = "http://optimisdev.com"
+  s.summary     = %q{Optimis Client library}
+  s.description = %q{a Ruby client library for Optimis Service}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency "typhoeus", "~> 0.2.3"
+  s.add_dependency "yajl-ruby"
+
+  s.add_development_dependency "rspec", "~> 2.5"
+end

data/spec/lib/base_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe OptimisClient::Base do
+
+  before do
+    OptimisClient::Base.host = 'service.optimis.local'
+    OptimisClient::Base.api_key = '1234567890'
+    OptimisClient::Base.secure = false
+  end
+
+  subject { OptimisClient::Base }
+
+  describe "Setup HTTP protocol" do
+
+    it "supports https" do
+      lambda { OptimisClient::Base.secure = true }.should_not raise_error
+    end
+
+    it "should raise error if your libcurl SSL support not enabled." do
+      Typhoeus::Easy.stub!(:new).and_return(mock("", :curl_version => "libcurl/7.19.7 OpenXXX/0.9.8l zlib/1.2.3"))
+      lambda { OptimisClient::Base.secure = true }.should raise_error(RuntimeError)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../../lib/optimis_client", __FILE__)
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+  
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: optimis_client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- OptimisDev Taipei Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &70127267720740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127267720740
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70127267719860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127267719860
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70127267718340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70127267718340
+description: a Ruby client library for Optimis Service
+email:
+- devteam-tw@optimiscorp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/optimis_client.rb
+- lib/optimis_client/base.rb
+- lib/optimis_client/version.rb
+- optimis_client.gemspec
+- spec/lib/base_spec.rb
+- spec/spec_helper.rb
+homepage: http://optimisdev.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Optimis Client library
+test_files:
+- spec/lib/base_spec.rb
+- spec/spec_helper.rb