tastyrb 0.1.0

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright © 2011, Dan Drinkard
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of Sunlight Foundation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,6 @@
+Tastyrb
+=======
+
+A thin wrapper for self-describing tastypie APIs
+
+Docs will go here.

data/lib/tastyrb.rb

@@ -0,0 +1,151 @@
+require 'httparty'
+require 'hashie'
+require 'json'
+require 'uri'
+
+module Tastyrb
+
+  class Client
+
+    module Connection
+      include HTTParty
+    end
+
+    attr_accessor :api_key, :api_key_param, :jsonp_callback, :word_separator, :limit
+    attr_reader :resources, :meta
+
+    def initialize(base_uri=nil, api_key=nil, jsonp_callback=nil)
+      @resources = []
+      @api_key = api_key
+      @api_key_param = 'api_key'
+      @jsonp_callback = jsonp_callback
+      @word_separator = '_'
+      set_base_uri(base_uri)
+    end
+
+    def base_uri=(uri)
+      set_base_uri(uri)
+    end
+
+    def base_uri
+      @base_uri
+    end
+
+    def base_uri_path
+      URI.parse(@base_uri).path
+    end
+
+    def get(method, options)
+      params = prepare_options options
+      if params[:callback]
+        Connection.format :plain
+      else
+        Connection.format :json
+      end
+
+      response = Connection.get "#{@base_uri}#{path_for(method)}", :query => params
+
+      if response.code == 200
+        # JSONP
+        return response.body if Connection.format == :plain
+
+        # JSON
+        result = JSON.parse(response.body)['objects']
+        meta = JSON.parse(response.body)['meta']
+        @meta = Response.new(meta)
+
+        if result.size == 0
+          raise ResponseCodeError, "404: No document found"
+        elsif result.size == 1 && (options.keys.join(' ') =~ /(^|[\s\b_])id(?=\b|__)(?!__(in|i?(contains|(starts|ends)with)))/) != nil
+          # if we asked for an item by id and only one was returned, return just the object,
+          # else return a list always
+          Response.new(result[0])
+        else
+          result.map {|object| Response.new(object)}
+        end
+      else
+        raise ResponseCodeError, "#{response.code}: #{response.body}"
+      end
+
+    end
+
+    def next
+      get_from_meta(meta.next)
+    end
+
+    def previous
+      get_from_meta(meta.previous)
+    end
+
+    private
+
+    def get_from_meta(uri)
+      path, params = uri.split('?')
+      params = Hash[*params.split(/[&=]/)]
+      params.delete('format')
+      get method_for(path), params
+    end
+
+    def method_for(path)
+      path.to_s.sub(base_uri_path, '').gsub('/', '__').gsub(@word_separator, '_')
+    end
+
+    def path_for(method)
+      method.to_s.gsub('__', '/').gsub('_', @word_separator)
+    end
+
+    def prepare_options(options)
+      options[:callback] = @jsonp_callback if @jsonp_callback
+      options[:limit] = @limit if @limit
+
+      if options[:callback] != nil
+        options[:format] = 'jsonp'
+      else
+        options[:format] = 'json'
+      end
+
+      options.merge @api_key_param.to_sym => @api_key
+    end
+
+    def set_base_uri(uri)
+      @base_uri = uri =~ /\/$/ ? uri : "#{uri}/"
+      redefine_resources!
+    end
+
+    def redefine_resources!
+      # a given base_uri has unique resources associated with it
+      # we map them dynamically to methods each time the url changes
+      #> c = Tastyrb::Client.new
+      #> c.base_uri='http://example.com/api/v1'
+      #> c.my__search__method(:keywords=>'foo')
+      if @base_uri
+        @resources.each do |resource|
+          (class << self; self; end).class_eval do
+            remove_method resource
+          end
+        end
+
+        resource_desc = Connection.get(@base_uri, :query=>{:format=>'json'})
+        @resources = resource_desc.parsed_response.map do |resource|
+          method_for(resource[0]).to_sym
+        end
+
+        @resources.each do |resource|
+          (class << self; self; end).class_eval do
+            define_method resource do |*args|
+              get(resource, args[0]||{})
+            end
+          end
+        end
+      end
+    end
+
+  end
+
+  class ResponseCodeError < RuntimeError
+  end
+
+  class Response < Hashie::Mash
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: tastyrb
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Drinkard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 3
+        version: 1.1.3
+  type: :runtime
+  version_requirements: *id003
+description: Generic client for self-describing APIs built with django-tastypie.
+email: dan.drinkard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/tastyrb.rb
+- README.md
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/dandrinkard/tastyrb/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Generic client for self-describing APIs built with django-tastypie.
+test_files: []
+