simple_sdk_builder 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+= Simple SDK Builder
+
+== Version 1.0.0
+* Initial release of gem

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2012 RevPAR Collective, Inc.
+
+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.rdoc

@@ -0,0 +1,72 @@
+= Simple SDK Builder
+
+A set of libraries that make it easy to build an SDK gem on top of an HTTP web service.
+
+Currently, only RESTful JSON services are supported.
+
+== Synopsis:
+
+ class MyNotFoundError < StandardError
+   def initialize(response)
+     super "object not found: #{response.body}"
+   end
+ end
+
+ class MyUnknownError < StandardError; end
+
+ class MyBaseClass
+   include SimpleSDKBuilder::Base
+
+   config :service_url => 'https://api.davidmdawson.com'
+   config :timeout => 15000
+   config :error_handlers => {
+     '404' => MyNotFoundError,
+     '*' => MyUnknownError
+   }
+
+ end
+
+ class MyResource < MyBaseClass
+   include SimpleSDKBuilder::Resource
+
+   simple_sdk_attribute :id, :name, :value
+
+   class << self
+
+     def all
+       response = json_request( :path => "/my_resources" )
+       response.build(MyResource)
+     end
+
+     def find(id)
+       response = json_request( :path => "/my_resources/#{id}" )
+       response.build(MyResource)
+     end
+
+   end
+
+   def create
+     response = json_request( :path => "/my_resources", :method => :post, :body => self )
+     self.attributes = response.parsed_body
+     self
+   end
+
+   def update(attrs)
+     response = json_request( :path => "/my_resources/#{id}", :method => :put, :body => attrs )
+     self.attributes = response.parsed_body
+     self
+   end
+
+   def destroy
+     json_request( :path => "/my_resources/#{id}", :method => :delete )
+     # leaves current object alone
+   end
+
+ end
+
+ all_resources = MyResource.all
+ some_resource = MyResource.find(1)
+ new_resource = MyResource.new( :name => 'test', :value => 'this is a test' ).create
+ new_resource.update( :value => 'this test is almost done...' )
+ new_resource.destroy
+

data/lib/simple_sdk_builder/base.rb

@@ -0,0 +1,140 @@
+require 'active_model'
+require 'json'
+require 'simply_configurable'
+require 'typhoeus'
+
+module SimpleSDKBuilder
+module Base
+
+  DEFAULT_TIMEOUT_MILLISECONDS = 15000
+
+  def self.included(klass)
+    klass.class_eval do
+      include SimplyConfigurable
+    end
+
+    klass.extend ClassMethods
+
+    klass.config :service_url => "http://localhost:3000/v1"
+    klass.config :timeout => DEFAULT_TIMEOUT_MILLISECONDS
+    klass.config :error_handlers => {
+      nil => ConnectionError,
+      '404' => NotFoundError,
+      '422' => RequestError,
+      '*' => UnknownError
+    }
+    klass.config :logger => default_logger
+  end
+
+  def ==(other)
+    self.equal?(other) || (self.id && self.id == other.id && self.class == other.class)
+  end
+
+  def eql?(other)
+    self == other
+  end
+
+  def json_request(options = {})
+    self.class.json_request(options)
+  end
+
+  def logger
+    self.class.logger
+  end
+
+  private
+
+  def self.default_logger
+    if defined?(::Rails)
+      ::Rails.logger
+    else
+      logger = ::Logger.new(STDERR)
+      logger.level = ::Logger::INFO
+      logger
+    end
+  end
+
+  module ClassMethods
+
+    def json_request(options = {})
+      options = config.merge({
+        :path => '/',
+        :method => :get,
+        :body => nil,
+        :params => nil,
+        :build => false
+      }).merge(options)
+
+      options[:headers] = {
+        'Content-Type' => 'application/json'
+      }.merge(options[:headers] || {})
+
+      hydra = config[:hydra] || Typhoeus::Hydra.new
+
+      url = "#{options[:service_url]}#{options[:path]}"
+
+      request_body = options[:body]
+      if request_body && !request_body.is_a?(String)
+        request_body = request_body.to_json
+      end
+
+      request = Typhoeus::Request.new url,
+        :method => options[:method],
+        :timeout => options[:timeout],
+        :headers => options[:headers],
+        :params => options[:params],
+        :body => request_body
+
+      logger.debug "running HTTP #{options[:method]}: #{url}; PARAMS: #{options[:params]}; BODY: #{request_body};"
+
+      hydra.queue(request)
+      hydra.run
+
+      response = request.response
+
+      logger.debug "received response code #{response.code}; BODY: #{response.body};"
+
+      check_response(response)
+      Response.new(response)
+    end
+
+    def check_response(response)
+      return if response.code.to_s =~ /^2/
+
+      error_handlers = config[:error_handlers] || {}
+      error_handlers[nil] ||= StandardError
+      error_handlers['*'] ||= StandardError
+
+      if response.timed_out?
+        raise error_handlers[nil], "timed out before receiving response"
+      end
+
+      # search for exact match
+      error_handlers.each do |key, error|
+        if key.is_a?(String) || key.is_a?(Symbol)
+          if response.code.to_s == key.to_s
+            raise error, response
+          end
+        end
+      end
+
+      # search for regex match
+      error_handlers.each do |key, error|
+        if key.is_a?(Regexp)
+          if !!(key =~ response.code.to_s)
+            raise error, response
+          end
+        end
+      end
+
+      raise error_handlers['*'], "an error occurred with the response; code: #{response.code}; body: #{response.body};"
+    end
+
+    def logger
+      config[:logger]
+    end
+
+  end
+
+end
+end

data/lib/simple_sdk_builder/errors.rb

@@ -0,0 +1,34 @@
+require 'typhoeus'
+
+module SimpleSDKBuilder
+
+  # An abstract super-class of all other SimpleSDKBuilder Error classes
+  class Error < StandardError
+    attr_reader :code
+
+    def initialize(response)
+      if response.is_a?(Typhoeus::Response)
+        @code = response.code
+        super(response.body)
+      else
+        super(response.to_s)
+      end
+    end
+  end
+  
+  # Indicates an error establishing a connection to the API, or a timeout that occurs while
+  # making an API call. Is relatively common and transient- worth retrying in important cases.
+  class ConnectionError < Error; end
+
+  # Indicates that the requested object was not found.
+  class NotFoundError < Error; end
+
+  # Indicates that something was wrong with the request. See the message for details.
+  class RequestError < Error; end
+  
+  # Indicates any other API error (generally should be non-transient and not worth retrying). The
+  # error code and string will be present in this error's message if one was provided in the
+  # response.
+  class UnknownError < Error; end
+
+end

data/lib/simple_sdk_builder/resource.rb

@@ -0,0 +1,122 @@
+require 'active_model'
+require 'active_support/core_ext/hash'
+require 'active_support/inflector'
+
+module SimpleSDKBuilder
+module Resource
+
+  def self.included(klass)
+    klass.class_eval do
+      extend ActiveModel::Naming
+      include ActiveModel::Conversion
+      include ActiveModel::Serializers::JSON
+      self.include_root_in_json = false
+    end
+
+    klass.extend ClassMethods
+  end
+
+  def initialize(attrs = {})
+    @attributes = {}.with_indifferent_access
+    #self.class.simple_sdk_attributes.each do |attr|
+    #  @attributes[attr] = nil
+    #end
+    self.attributes = attrs
+  end
+
+  def attributes
+    @attributes
+  end
+
+  def attributes=(attributes)
+    attributes.each do |key, value|
+      if self.class.simple_sdk_attributes.include?(key.to_s)
+        self.send("#{key}=", value)
+      end
+    end
+  end
+
+  def persisted?
+    !!id
+  end
+
+  private
+
+  def write_attribute(attr, value, options = {})
+    @attributes[attr] = build_attribute(attr, value, options)
+  end
+
+  def build_attribute(attr, value, options)
+    options = {
+      :class_name => nil,
+      :nested => false
+    }.merge(options)
+
+    if options[:nested] && value.is_a?(Array)
+      value.collect { |v| build_attribute(attr, v, options) }
+    elsif options[:nested] && value.is_a?(Hash) && value.include?("0")
+      arr = []
+      (0...(value.size)).each do |i|
+        arr.push value[i.to_s]
+      end
+      build_attribute(attr, arr, options)
+    elsif options[:nested] && value.is_a?(Hash)
+      class_name = options[:class_name] || guess_class_name(attr)
+      nested_class = eval(class_name)
+      nested_class.new(value)
+    else
+      value
+    end
+  end
+
+  def guess_class_name(attr)
+    namespace = ''
+    class_name = self.class.name
+    if class_name.rindex(':')
+      namespace = class_name[0..class_name.rindex(':')]
+    end
+    attr.chomp!("_attributes")
+    result = "#{namespace}#{attr.camelize.singularize}"
+    result
+  end
+
+  module ClassMethods
+
+    def simple_sdk_attribute(*attrs)
+      attrs.each do |attr|
+        attr = attr.to_s
+        simple_sdk_attributes.push(attr)
+        define_method attr do
+          @attributes[attr]
+        end
+        define_method "#{attr}=" do |value|
+          write_attribute(attr, value)
+        end
+      end
+    end
+
+    def simple_sdk_nested_attribute(attr, options = {})
+      options = {
+        :nested => true
+      }.merge(options)
+      attr = attr.to_s
+      simple_sdk_attributes.push(attr)
+      simple_sdk_attributes.push("#{attr}_attributes") # for ActiveRecord nested attributes
+      define_method attr do
+        @attributes[attr] ||= []
+      end
+      alias_method :"#{attr}_attributes", :"#{attr}" # for ActiveRecord nested attributes
+      define_method "#{attr}=" do |value|
+        write_attribute(attr, value, options)
+      end
+      alias_method :"#{attr}_attributes=", :"#{attr}=" # for ActiveRecord nested attributes
+    end
+
+    def simple_sdk_attributes
+      @simple_sdk_attributes ||= []
+    end
+
+  end
+
+end
+end

data/lib/simple_sdk_builder/response.rb

@@ -0,0 +1,44 @@
+require 'json'
+
+module SimpleSDKBuilder
+class Response
+
+  def initialize(typhoeus_response)
+    @typhoeus_response = typhoeus_response
+  end
+
+  def code
+    @typhoeus_response.code
+  end
+
+  def time
+    @typhoeus_response.time
+  end
+
+  def headers
+    @typhoeus_response.headers_hash
+  end
+
+  def body
+    @typhoeus_response.body
+  end
+
+  def parsed_body
+    @parsed_body ||= JSON.parse(body)
+  end
+
+  def build(type)
+    if parsed_body.is_a?(Array)
+      parsed_body.collect { |value| type.new.from_json(value.to_json) }
+    else
+      type.new.from_json(body)
+    end
+  end
+
+  def build_search_results(type)
+    SearchResults.new(self, type)
+  end
+
+end
+end
+

data/lib/simple_sdk_builder/search_results.rb

@@ -0,0 +1,20 @@
+module SimpleSDKBuilder
+class SearchResults
+
+  attr_reader :result_count, :links, :results
+
+  def initialize(response, type)
+    @result_count = response.headers['X-Count'].to_s.to_i
+
+    @links = {}
+    response.headers['Link'].to_s.split(',').each do |link|
+      if link =~ /<(.*)>; rel="(.*)"/
+        @links[$2] = $1
+      end
+    end
+
+    @results = response.build(type)
+  end
+
+end
+end

data/lib/simple_sdk_builder/version.rb

@@ -0,0 +1,3 @@
+module SimpleSDKBuilder
+  VERSION = '0.0.1'
+end

data/lib/simple_sdk_builder.rb

@@ -0,0 +1,20 @@
+# This file should require or autoload the implementation of this gem
+#
+# Example:
+#
+#  require 'my_gem/my_extension'
+#
+#  module MyGem
+#    autoload :MyClass, 'my_gem/my_class'
+#  end
+
+require 'simple_sdk_builder/errors'
+
+module SimpleSDKBuilder
+
+  autoload :Base, 'simple_sdk_builder/base'
+  autoload :Resource, 'simple_sdk_builder/resource'
+  autoload :Response, 'simple_sdk_builder/response'
+  autoload :SearchResults, 'simple_sdk_builder/search_results'
+
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: simple_sdk_builder
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Dawson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  version_requirements: *id001
+  name: activemodel
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  version_requirements: *id002
+  name: activesupport
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  version_requirements: *id003
+  name: json
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  version_requirements: *id004
+  name: simply_configurable
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  version_requirements: *id005
+  name: typhoeus
+  prerelease: false
+  type: :runtime
+description: A set of libraries that supports building an object-oriented ruby SDK on top of a RESTful JSON web service.
+email: daws23@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.txt
+files: 
+- lib/simple_sdk_builder/base.rb
+- lib/simple_sdk_builder/errors.rb
+- lib/simple_sdk_builder/resource.rb
+- lib/simple_sdk_builder/response.rb
+- lib/simple_sdk_builder/search_results.rb
+- lib/simple_sdk_builder/version.rb
+- lib/simple_sdk_builder.rb
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.txt
+homepage: https://github.com/daws/simple_sdk_builder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Makes building SDKs for RESTful JSON services easy.
+test_files: []
+