pixallent-fetchapi-ruby 0.9.1 → 0.9.2

data/CHANGELOG

@@ -1,3 +1,7 @@
+v.0.9.2 Prelim RDoc complete; misc fixes to all classes
+
+v.0.9.1 Prelim BETA
+
 v.0.9	Item Support
 
 v.0.2.2 Order support

data/README

@@ -1,13 +1,17 @@
-== Installation                                                              
+= Installation
+ From Github
 	gem sources -a http://gems.github.com (you only have to do this once)
 	gem install pixallent-fetchapi-ruby                                                   
+ 
+ RubyForge
+	coming soon!
                 
 = Setup
 	FetchAPI::Base.basic_auth('youraccount.fetchapp.com', 'demokey', 'demotoken')
 	
 = Account
 
-	FetchAPI::Account.details
+	account = FetchAPI::Account.details
 	
 	token = FetchAPI::Account.new_token  *Subsequent calls will use the new token automatically
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('fetchapi-ruby', '0.9.1') do |p|
+Echoe.new('fetchapi-ruby', '0.9.2') do |p|
   p.description    = "Integrate your site with http://fetchapp.com for seamless digital delivery."
   p.url            = "http://github.com/pixallent/fetchapi-ruby"
   p.author         = ["Thomas Reynolds, Michael Larkin"]

data/fetchapi-ruby.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fetchapi-ruby}
-  s.version = "0.9.1"
+  s.version = "0.9.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thomas Reynolds, Michael Larkin"]
-  s.date = %q{2009-05-01}
+  s.date = %q{2009-05-04}
   s.description = %q{Integrate your site with http://fetchapp.com for seamless digital delivery.}
   s.email = %q{mikelarkin@pixallent.com}
   s.extra_rdoc_files = ["CHANGELOG", "lib/fetchapi/account.rb", "lib/fetchapi/base.rb", "lib/fetchapi/download.rb", "lib/fetchapi/item.rb", "lib/fetchapi/order.rb", "lib/fetchapi-ruby.rb", "LICENSE", "README"]

data/lib/fetchapi/account.rb

@@ -1,12 +1,15 @@
 module FetchAPI
   class Account < FetchAPI::Base
+	 attr_accessor :attributes
     #--
     ################ Class Methods ###############
     #--
 
     # Retrieves information about the Account
     def self.details
-      new(execute(:get, "/account"))
+		account = Account.new({})
+		account.attributes = execute(:get, "/account")["account"]
+		account
     end
 
     # Generates a new API token.  Subsequent API calls using the
@@ -15,8 +18,7 @@ module FetchAPI
       token = execute(:get, "/new_token")
       unless token["message"].blank?
         # Reauthorize
-		  puts "XXXXXXXX #{token["message"]}"
-		  Connector.basic_auth(@key, token["message"])
+		  Connector.basic_auth(FetchAPI::Base.key, token["message"])
         token
       end
     end

data/lib/fetchapi/base.rb

@@ -1,7 +1,7 @@
 module FetchAPI
   class Base
-
-    def initialize(id_or_attributes)
+    require 'pp'
+    def initialize(id_or_attributes) #:nodoc:
       case id_or_attributes
       when Integer, String
         @attributes = get("/#{self.class.pluralized_class_name}/#{id_or_attributes.to_s}")
@@ -13,7 +13,7 @@ module FetchAPI
       end
     end
 
-    def self.find(selector, params={})
+    def self.find(selector, params={}) #:nodoc:
       case selector
       when :all
         objects = execute(:get, "/#{pluralized_class_name}")
@@ -28,38 +28,53 @@ module FetchAPI
       end
     end
 
-    class Connector
+    class Connector  #:nodoc:
       include HTTParty
       format :xml
     end
 
-    # Initializes the connection
+    # Initializes the connection to the API
     def self.basic_auth(url, key, token)
-		@key = key # Save this in case they generate a new token
+      @key = key # Save this in case they generate a new token later
       Connector.base_uri(url)
       Connector.basic_auth(key, token)
     end
 
+    def self.key #:nodoc:
+      return @key
+    end
+
     protected
-    def self.singularized_class_name
+    def self.singularized_class_name #:nodoc:
       ancestors.first.to_s.split('::').last.downcase
     end
-    def self.pluralized_class_name
+    def self.pluralized_class_name #:nodoc:
       ancestors.first.to_s.split('::').last.downcase << 's'
     end
 
-    def post(*args);   self.class.execute(:post, *args); end
-    def get(*args);    self.class.execute(:get, *args); end
-    def delete(*args); self.class.execute(:delete, *args); end
-    def put(*args);    self.class.execute(:put, *args); end
+    def post(*args) #:nodoc:
+      self.class.execute(:post, *args)
+    end
+
+    def get(*args) #:nodoc:
+      self.class.execute(:get, *args)
+    end
+
+    def delete(*args) #:nodoc:
+      self.class.execute(:delete, *args)
+    end
+
+    def put(*args) #:nodoc:
+      self.class.execute(:put, *args)
+    end
 
     # Do HTTP request, handle errors
-    def self.execute(action, path, options = {})
+    def self.execute(action, path, options = {}) #:nodoc:
       handle_response(Connector.send(action, path, :query => options))
       #Connector.send(action, path, options)
     end
 
-    def self.handle_response(response)
+    def self.handle_response(response) #:nodoc:
       case response.code
       when 100..199 then response
       when 200..299 then response
@@ -77,7 +92,7 @@ module FetchAPI
 
 
     # Access attributes as class methods of the Item object
-    def method_missing(method)
+    def method_missing(method) #:nodoc:
       return super unless attributes.has_key?(method.to_s)
       attributes[method.to_s]
     end

data/lib/fetchapi/download.rb

@@ -1,5 +1,11 @@
 module FetchAPI
   class Download < FetchAPI::Base
     attr_accessor :id, :attributes
+
+	 # Find :all downloads or the specified ID
+	 def self.find(selector, params={})
+		   super(selector, params={})
+    end
+
   end
 end

data/lib/fetchapi/item.rb

@@ -1,8 +1,8 @@
 module FetchAPI
   class Item < FetchAPI::Base
-	attr_accessor :id, :attributes
+    attr_accessor :id, :attributes
 
-    def initialize(id_or_attributes)
+    def initialize(id_or_attributes) #:nodoc:
       case id_or_attributes
       when Integer, String
         @attributes = get("/#{self.class.pluralized_class_name}/#{id_or_attributes.to_s}")
@@ -12,9 +12,18 @@ module FetchAPI
       end
     end
 
+
     #--
     ################ Class Methods ###############
     #--
+
+    # Find :all items or a specific SKU
+    def self.find(selector, params={})
+      super(selector, params={})
+    end
+
+
+    # Creates a new Item
     def self.create(options)
       return FetchAPI::Item.new(execute(:post, "/items/create", :item => options)["item"])
     end
@@ -23,21 +32,24 @@ module FetchAPI
     ################# Instance Methods ###############
     #--
 
+    # Permanently deletes the Item
     def destroy
       delete("/items/#{sku}/delete")
     end
 
+    # Immediately updates the Item
     def update(options)
       self.attributes = put("/items/#{sku}", :item => options)["item"]
-		self.id = self.sku
+      self.id = self.sku
     end
 
-	 def downloads
-		downloads = get("/items/#{sku}/downloads")
-		if downloads
-			downloads["downloads"].map { |data| FetchAPI::Download.new(data) }
-		end
-	 end
+    # Returns all the downloads associated with this Item
+    def downloads
+      downloads = get("/items/#{sku}/downloads")
+      if downloads
+        downloads["downloads"].map { |data| FetchAPI::Download.new(data) }
+      end
+    end
 
 
   end

data/lib/fetchapi/order.rb

@@ -6,7 +6,9 @@ module FetchAPI
     #--
     ################ Class Methods ###############
     #--
-
+    
+	 # Finds an Order or orders based on the specified parameters
+	 # :all, :current, :manual, :expired, or by ID
     def self.find(selector, params={})
       case selector
       when :current
@@ -38,7 +40,7 @@ module FetchAPI
       end
     end
 
-    # Creates a new order
+    # Creates a new Order
     def self.create(options={})
       return FetchAPI::Order.new(execute(:post, "/orders/create", :order => options)["order"])
     end
@@ -47,7 +49,7 @@ module FetchAPI
     ################# Instance Methods ###############
     #--
 
-    # Permanently deletes the order
+    # Permanently deletes the Order
     def destroy
       delete("/orders/#{id}/delete")
     end
@@ -65,11 +67,12 @@ module FetchAPI
       post("/orders/#{id}/send_email", options)
     end
 
-    # Immediately updates the order with the new parameters
+    # Immediately updates the Order with the new parameters
     def update(options={})
       self.attributes = put("/orders/#{id}", :order => options)["order"]
     end
-
+    
+	 # Returns all the downloads associated with this Order
     def downloads(params={})
       downloads = get("/orders/#{id}/downloads")
       if downloads

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pixallent-fetchapi-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - Thomas Reynolds, Michael Larkin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-01 00:00:00 -07:00
+date: 2009-05-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency