swivel 0.0.146 → 0.0.149

data/README

@@ -35,7 +35,7 @@ Most method calls take parameters.  Check out the
 
 == You need an API key
 
-You need an API key to perform any POST, PUT, or DELETE requests.  You must also use an API key to perform a GET request to access your private or shared data.  Get your API key from https://inviteonly.swivel.com/developer.  Please treat your API key as you would a password.
+You need an API key to perform any POST, PUT, or DELETE requests.  You must also use an API key to perform a GET request to access your private or shared data.  GET requests on public resources (such as users, or public data) do not require an API key.  But it never hurts to always send it.  Get your API key from https://inviteonly.swivel.com/developer.  Please treat your API key as you would a password.
 
 Your API key is stored in ~/.swivelrc along with some other information.  Copy the swivelrc.default provided with this gem to ~/.swivelrc and modify site parameter to include your API key.  Please make sure you set appropriate permissions on your ~/.swivelrc file to prevent others from seeing your API key.
 
@@ -79,6 +79,9 @@ key with each request.  For example:
 
     >> data_sets = connection.get '/data_sets'
 
+You can also construct a Swivel2::Connection without passing a config option
+to get a read-only connection that can only access public resources on Swivel.
+
 === Data sets
 
 ==== Show a data set

data/Rakefile

@@ -56,7 +56,7 @@ spec =
     s.email = 'huned@swivel.com'
     s.homepage = 'http://www.swivel.com/developer'
 
-    s.files = %w/COPYING README Rakefile/ + Dir['{lib,bin}/*']
+    s.files = %w/COPYING README Rakefile/ + Dir['{lib,bin,vendor}/**/*']
     s.require_path = "lib"
 
     s.bindir = "bin"

data/lib/swivel.rb

@@ -624,7 +624,7 @@ module Swivel
       'error'
     end
     def raise
-      super ApiError, message, backtrace.split("\n")
+      super ApiError, message, backtrace ? backtrace.split("\n") : ''
     end
   end
 

data/lib/swivel2/benchmarking.rb

@@ -0,0 +1 @@
+# benchmarking module

data/lib/swivel2/config.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+require 'uri'
+
+module Swivel2
+
+  class Config < Struct.new :site, :timeout_read, :timeout_write, :extra_params
+    def initialize options = {}
+      options.each do |k, v| self[k] = v end
+    end
+
+    def extra_params
+      super || {}
+    end
+
+    def save file = nil
+      File.open file || Config.config_file, 'w' do |f|
+        YAML.dump self, f
+      end
+    end
+
+    def self.load file = nil
+      YAML.load_file(file || config_file)
+    end
+
+    def self.default
+      @@default ||= self.load default_config_file
+    end
+
+    private
+
+      def self.config_file
+        case PLATFORM
+        when /win32/
+          ENV['USERPROFILE'] + '\_swivelrc'
+        else
+          ENV['HOME'] + '/.swivelrc'
+        end
+      end
+
+      def self.default_config_file
+        File.dirname(__FILE__) + '/swivelrc.default'
+      end
+  end
+
+end

data/lib/swivel2/connection.rb

@@ -0,0 +1,89 @@
+module Swivel2
+
+  class Connection
+    attr_reader :config, :resource, :format
+
+    def initialize config = Config.default
+      @config = config.is_a?(Hash) ? Config.new(config) : config
+      @resource = ActiveResource::Connection.new @config.site
+      @format = Swivel2::Formats::XmlFormat
+    end
+
+    def post path, params = {}, headers = {}
+      request :post, path, params, headers
+    end
+
+    def get path, params = {}, headers = {}
+      request :get, path, params, headers
+    end
+
+    def put path, params = {}, headers = {}
+      request :put, path, params, headers
+    end
+
+    def delete path, params = {}, headers = {}
+      request :delete, path, params, headers
+    end
+
+    def call path, params = {}, method = :get, headers = {}
+      request method, path, params, headers
+    end
+
+    [ :post, :get, :put, :delete, :call ].each do |m|
+      define_method "#{m}!" do |*args|
+        returning send(m, *args) do |r|
+          r.raise  if Swivel::Error === r
+        end
+      end
+    end
+
+    deprecate :call, :call!
+
+    def error exception
+      build format.decode(exception.response.body)
+    end
+
+    private
+
+      def combine path, params = {}
+        if params.empty?
+          path
+        else
+          path, qs = path.split '?'
+          qs = qs.blank? ? params.to_query : qs + '&' + params.to_query
+          [ path, qs ].join '?'
+        end
+      end
+
+      def request method, path, params = {}, headers = {}
+        params = params.merge config.extra_params  if params.is_a? Hash
+
+        headers = default_headers.merge headers
+        headers = resource.send :build_request_headers, headers
+
+        response =
+          if method == :get || method == :delete
+            resource.send :request, method, combine(path, params), headers
+          else
+            params = params.to_query  if params.is_a? Hash
+            resource.send :request, method, path, params, headers
+          end
+        build format.decode(response.body)
+      end
+
+      def build hash
+        response = Swivel2::Response.new hash.values.first
+        response.attributes.values.find do |v|
+          ActiveResource::Base === v or Array === v
+        end
+      end
+
+      def default_headers
+        @@default_headers ||=
+          { 'Accept' => 'application/xml',
+            'Content-Type' => 'application/x-www-form-urlencoded' }
+      end
+
+  end
+
+end

data/lib/swivel2/formats.rb

@@ -0,0 +1,11 @@
+module Swivel2
+  module Formats
+    module XmlFormat
+      extend self
+
+      def decode xml
+        Hash.from_xml xml
+      end
+    end
+  end
+end

data/lib/swivel2/logging.rb

@@ -0,0 +1 @@
+# logging module

data/lib/swivel2/performance.rb

@@ -0,0 +1,21 @@
+# make xml-simple and active resource a lot faster
+begin
+  require 'faster_xml_simple'
+  class Hash
+    def self.from_xml_faster(xml)
+      undasherize_keys(typecast_xml_value(FasterXmlSimple.xml_in(xml,
+        'forcearray'   => false,
+        'forcecontent' => true,
+        'keeproot'     => true,
+        'contentkey'   => '__content__')
+      ))
+    end
+  end
+
+  module Swivel2::Formats::XmlFormat
+    def decode xml
+      Hash.from_xml_faster xml
+    end
+  end
+rescue LoadError
+end

data/lib/swivel2/response.rb

@@ -0,0 +1,5 @@
+module Swivel2
+  class Response < ActiveResource::Base
+    self.site = Config.default.site
+  end
+end

data/lib/swivel2/swivelrc.default

@@ -0,0 +1,5 @@
+--- !ruby/struct:Swivel2::Config 
+site: https://api.swivel.com
+timeout_read: 500
+timeout_write: 1_000
+extra_params: { noviews: true }

data/vendor/activeresource-2.0.2-/CHANGELOG

@@ -0,0 +1,223 @@
+*2.0.2* (December 16th, 2007)
+
+* Added more specific exceptions for 400, 401, and 403 (all descending from ClientError so existing rescues will work) #10326 [trek]
+
+* Correct empty response handling.  #10445 [seangeo]
+
+
+*2.0.1* (December 7th, 2007)
+
+* Don't cache net/http object so that ActiveResource is more thread-safe.  Closes #10142 [kou]
+
+* Update XML documentation examples to include explicit type attributes. Closes #9754 [hasmanyjosh]
+
+* Added one-off declarations of mock behavior [DHH]. Example:
+
+    Before:
+      ActiveResource::HttpMock.respond_to do |mock|
+        mock.get "/people/1.xml", {}, "<person><name>David</name></person>"
+      end
+      
+    Now:
+      ActiveResource::HttpMock.respond_to.get "/people/1.xml", {}, "<person><name>David</name></person>"
+
+* Added ActiveResource.format= which defaults to :xml but can also be set to :json [DHH]. Example:
+
+    class Person < ActiveResource::Base
+      self.site   = "http://app/"
+      self.format = :json
+    end
+    
+    person = Person.find(1) # => GET http://app/people/1.json
+    person.name = "David"
+    person.save             # => PUT http://app/people/1.json {name: "David"}
+    
+    Person.format = :xml
+    person.name = "Mary"
+    person.save             # => PUT http://app/people/1.json <person><name>Mary</name></person>    
+
+* Fix reload error when path prefix is used.  #8727 [Ian Warshak]
+
+* Remove ActiveResource::Struct because it hasn't proven very useful. Creating a new ActiveResource::Base subclass is often less code and always clearer.  #8612 [Josh Peek]
+
+* Fix query methods on resources. [Cody Fauser]
+
+* pass the prefix_options to the instantiated record when using find without a specific id. Closes #8544 [alloy]
+
+* Recognize and raise an exception on 405 Method Not Allowed responses.  #7692 [Josh Peek]
+
+* Handle string and symbol param keys when splitting params into prefix params and query params.
+
+    Comment.find(:all, :params => { :article_id => 5, :page => 2 }) or Comment.find(:all, :params => { 'article_id' => 5, :page => 2 })
+
+* Added find-one with symbol [DHH]. Example: Person.find(:one, :from => :leader) # => GET /people/leader.xml
+
+* BACKWARDS INCOMPATIBLE: Changed the finder API to be more extensible with :params and more strict usage of scopes [DHH]. Changes:
+
+    Person.find(:all, :title => "CEO")      ...becomes: Person.find(:all, :params => { :title => "CEO" })
+    Person.find(:managers)                  ...becomes: Person.find(:all, :from => :managers)
+    Person.find("/companies/1/manager.xml") ...becomes: Person.find(:one, :from => "/companies/1/manager.xml")
+
+* Add support for setting custom headers per Active Resource model [Rick]
+
+  class Project
+    headers['X-Token'] = 'foo'
+  end
+  
+  # makes the GET request with the custom X-Token header
+  Project.find(:all)
+
+* Added find-by-path options to ActiveResource::Base.find [DHH]. Examples:
+
+    employees = Person.find(:all, :from => "/companies/1/people.xml") # => GET /companies/1/people.xml
+    manager   = Person.find("/companies/1/manager.xml")               # => GET /companies/1/manager.xml
+
+
+* Added support for using classes from within a single nested module [DHH]. Example:
+
+    module Highrise
+      class Note < ActiveResource::Base
+        self.site = "http://37s.sunrise.i:3000"
+      end
+
+      class Comment < ActiveResource::Base
+        self.site = "http://37s.sunrise.i:3000"
+      end
+    end
+
+  assert_kind_of Highrise::Comment, Note.find(1).comments.first
+    
+
+* Added load_attributes_from_response as a way of loading attributes from other responses than just create [DHH]
+
+    class Highrise::Task < ActiveResource::Base
+      def complete
+        load_attributes_from_response(post(:complete))
+      end
+    end
+
+  ...will set "done_at" when complete is called.
+
+
+* Added support for calling custom methods #6979 [rwdaigle]
+
+    Person.find(:managers)    # => GET /people/managers.xml
+    Kase.find(1).post(:close) # => POST /kases/1/close.xml
+
+* Remove explicit prefix_options parameter for ActiveResource::Base#initialize. [Rick]
+  ActiveResource splits the prefix_options from it automatically.
+
+* Allow ActiveResource::Base.delete with custom prefix. [Rick]
+
+* Add ActiveResource::Base#dup [Rick]
+
+* Fixed constant warning when fetching the same object multiple times [DHH]
+
+* Added that saves which get a body response (and not just a 201) will use that response to update themselves [DHH]
+
+* Disregard namespaces from the default element name, so Highrise::Person will just try to fetch from "/people", not "/highrise/people" [DHH]
+
+* Allow array and hash query parameters.  #7756 [Greg Spurrier]
+
+* Loading a resource preserves its prefix_options.  #7353 [Ryan Daigle]
+
+* Carry over the convenience of #create from ActiveRecord.  Closes #7340.  [Ryan Daigle]
+
+* Increase ActiveResource::Base test coverage.  Closes #7173, #7174 [Rich Collins]
+
+* Interpret 422 Unprocessable Entity as ResourceInvalid.  #7097 [dkubb]
+
+* Mega documentation patches. #7025, #7069 [rwdaigle]
+
+* Base.exists?(id, options) and Base#exists? check whether the resource is found.  #6970 [rwdaigle]
+
+* Query string support.  [untext, Jeremy Kemper]
+    # GET /forums/1/topics.xml?sort=created_at
+    Topic.find(:all, :forum_id => 1, :sort => 'created_at')
+
+* Base#==, eql?, and hash methods. == returns true if its argument is identical to self or if it's an instance of the same class, is not new?, and has the same id. eql? is an alias for ==. hash delegates to id.  [Jeremy Kemper]
+
+* Allow subclassed resources to share the site info [Rick, Jeremy Kemper]
+d
+    class BeastResource < ActiveResource::Base
+      self.site = 'http://beast.caboo.se'
+    end
+
+    class Forum < BeastResource
+      # taken from BeastResource
+      # self.site = 'http://beast.caboo.se'
+    end
+
+    class Topic < BeastResource
+      self.site += '/forums/:forum_id'
+    end
+
+* Fix issues with ActiveResource collection handling.  Closes #6291. [bmilekic]
+
+* Use attr_accessor_with_default to dry up attribute initialization. References #6538. [Stuart Halloway]
+
+* Add basic logging support for logging outgoing requests. [Jamis Buck]
+
+* Add Base.delete for deleting resources without having to instantiate them first. [Jamis Buck]
+
+* Make #save behavior mimic AR::Base#save (true on success, false on failure). [Jamis Buck]
+
+* Add Basic HTTP Authentication to ActiveResource (closes #6305). [jonathan]
+
+* Extracted #id_from_response as an entry point for customizing how a created resource gets its own ID.
+  By default, it extracts from the Location response header.
+
+* Optimistic locking: raise ActiveResource::ResourceConflict on 409 Conflict response. [Jeremy Kemper]
+
+    # Example controller action
+    def update
+      @person.save!
+    rescue ActiveRecord::StaleObjectError
+      render :xml => @person.reload.to_xml, :status => '409 Conflict'
+    end
+
+* Basic validation support [Rick Olson]
+
+  Parses the xml response of ActiveRecord::Errors#to_xml with a similar interface to ActiveRecord::Errors.  
+  
+    render :xml => @person.errors.to_xml, :status => '400 Validation Error'
+
+* Deep hashes are converted into collections of resources.  [Jeremy Kemper]
+    Person.new :name => 'Bob',
+               :address => { :id => 1, :city => 'Portland' },
+               :contacts => [{ :id => 1 }, { :id => 2 }]
+  Looks for Address and Contact resources and creates them if unavailable.
+  So clients can fetch a complex resource in a single request if you e.g.
+    render :xml => @person.to_xml(:include => [:address, :contacts])
+  in your controller action.
+
+* Major updates [Rick Olson]
+
+  * Add full support for find/create/update/destroy
+  * Add support for specifying prefixes.
+  * Allow overriding of element_name, collection_name, and primary key
+  * Provide simpler HTTP mock interface for testing
+  
+    # rails routing code
+    map.resources :posts do |post|
+      post.resources :comments
+    end
+    
+    # ActiveResources
+    class Post < ActiveResource::Base
+      self.site = "http://37s.sunrise.i:3000/"
+    end
+
+    class Comment < ActiveResource::Base
+      self.site = "http://37s.sunrise.i:3000/posts/:post_id/"
+    end
+    
+    @post     = Post.find 5
+    @comments = Comment.find :all, :post_id => @post.id
+
+    @comment  = Comment.new({:body => 'hello world'}, {:post_id => @post.id})
+    @comment.save
+
+* Base.site= accepts URIs. 200...400 are valid response codes. PUT and POST request bodies default to ''. [Jeremy Kemper]
+
+* Initial checkin: object-oriented client for restful HTTP resources which follow the Rails convention. [DHH]