fetchapp-api-ruby 1.2.4

data/CHANGELOG

@@ -0,0 +1,21 @@
+v.1.2.4 Removed dependency on ActiveRecord and Active Support
+
+v.1.2.3 Invalid Path
+
+v.1.2.2 Pull request
+
+v.1.2.1 Rename for legal reasons
+
+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
+
+v.0.2.1 Prelim rework
+
+v.0.2 Functionality for Downloads and Account
+
+v.0.1 Functionality for Orders and Items

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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/Manifest

@@ -0,0 +1,13 @@
+CHANGELOG
+fetchapp-api-ruby.gemspec
+init.rb
+lib/fetchapp-api-ruby/account.rb
+lib/fetchapp-api-ruby/base.rb
+lib/fetchapp-api-ruby/download.rb
+lib/fetchapp-api-ruby/item.rb
+lib/fetchapp-api-ruby/order.rb
+lib/fetchapp-api-ruby-ruby.rb
+LICENSE
+Manifest
+Rakefile
+README.md

data/README.md

@@ -0,0 +1,55 @@
+# Installation from RubyGems.org
+	gem install fetchapp-api-ruby
+
+
+# Setup
+```ruby
+	FetchAPI::Base.basic_auth('youraccount.fetchapp.com', 'demokey', 'demotoken')
+```
+# Account
+```ruby
+	account = FetchAPI::Account.details
+
+	token = FetchAPI::Account.new_token  *Subsequent calls will use the new token automatically
+```
+# Downloads
+```ruby
+	downloads = FetchAPI::Download.find(:all, :per_page => 50, :page => 2)
+
+	download = FetchAPI::Download.find(1)
+```
+
+# Items
+```ruby
+	items = FetchAPI::Item.find(:all, :per_page => 10, :page => 3)
+
+	item = FetchAPI::Item.find("CJ0001")
+
+	item = FetchAPI::Item.create(:sku => "CJ0001", :name => "Carrot Juice")
+
+	item.update(:name => "Tomato Juice")
+
+	item.destroy
+
+	downloads = item.downloads  *Returns an array of FetchAPI::Downloads for this item
+```
+# Orders
+```ruby
+	all_orders = FetchAPI::Order.find(:all)
+
+	current_orders = FetchAPI::Order.find(:current, :page => 3)
+
+	manual_orders = FetchAPI::Order.find(:manual, :per_page => 10)
+
+	expired_orders = FetchAPI::Order.find(:expired, :per_page => 10, :page => 3)
+
+	order = FetchAPI::Order.find("1001")
+
+	order = FetchAPI::Order.create(:id => "1015", :title => "Test Order", :first_name => "Donald", :last_name => "Duck", :email => "donald@duck.com", :order_items => [{:sku => 'ABC0001'}, {:sku => 'ABC0002}])
+
+	order.update(:first_name => "Daffy")
+
+	order.destroy
+
+	downloads = order.downloads  *Returns an array of FetchAPI::Downloads for this order
+```

data/fetchapp-api-ruby.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fetchapp-api-ruby}
+  s.version = "1.2.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Larkin"]
+  s.date = Date.today.strftime('%Y-%m-%d')
+  s.description = %q{Integrate your site with http://fetchapp.com for seamless digital delivery.}
+  s.email = %q{support@fetchapp.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/fetchapp-api-ruby/account.rb", "lib/fetchapp-api-ruby/base.rb", "lib/fetchapp-api-ruby/download.rb", "lib/fetchapp-api-ruby/item.rb", "lib/fetchapp-api-ruby/order.rb", "lib/fetchapp-api-ruby.rb", "LICENSE", "README.md"]
+  s.files = ["CHANGELOG", "fetchapp-api-ruby.gemspec", "init.rb", "lib/fetchapp-api-ruby/account.rb", "lib/fetchapp-api-ruby/base.rb", "lib/fetchapp-api-ruby/download.rb", "lib/fetchapp-api-ruby/item.rb", "lib/fetchapp-api-ruby/order.rb", "lib/fetchapp-api-ruby.rb", "LICENSE", "Manifest", "Rakefile", "README.md"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/getsy/fetchapp-api-ruby}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "fetchapp-api-ruby", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{This Ruby library allows you to integrate your site with http://fetchapp.com for seamless digital delivery so you can build additional functionality while retaining the core features of Fetch.  Credit for the bulk of the code goes to Thomas Reynolds.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'fetchapp-api-ruby')

data/lib/fetchapp-api-ruby.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'httparty'
+require 'net/http'
+
+$:.unshift(File.dirname(__FILE__))
+require 'fetchapp-api-ruby/base'
+require 'fetchapp-api-ruby/account'
+require 'fetchapp-api-ruby/download'
+require 'fetchapp-api-ruby/item'
+require 'fetchapp-api-ruby/order'

data/lib/fetchapp-api-ruby/account.rb

@@ -0,0 +1,26 @@
+module FetchAPI
+  class Account < FetchAPI::Base
+   attr_accessor :attributes
+    #--
+    ################ Class Methods ###############
+    #--
+
+    # Retrieves information about the Account
+    def self.details
+    account = Account.new({})
+    account.attributes = execute(:get, "/account")["account"]
+    account
+    end
+
+    # Generates a new API token.  Subsequent API calls using the
+    # existing token will be refused.
+    def self.new_token
+      token = execute(:get, "/new_token")
+      unless token["message"].nil? || token["message"].empty?
+        # Reauthorize
+        Connector.basic_auth(FetchAPI::Base.key, token["message"])
+        token
+      end
+    end
+  end
+end

data/lib/fetchapp-api-ruby/base.rb

@@ -0,0 +1,103 @@
+module FetchAPI
+  class Base
+    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}")
+          @attributes = @attributes[self.class.singularized_class_name]
+          @id = @attributes['id']
+        when Hash
+          @attributes = id_or_attributes
+          @id = id_or_attributes['id']
+      end
+    end
+
+    def self.find(selector, params={}) #:nodoc:
+      case selector
+        when :all
+          objects = execute(:get, "/#{pluralized_class_name}", params)
+
+          if objects[pluralized_class_name].nil? || objects[pluralized_class_name].empty?
+            return []
+          else
+            objects[pluralized_class_name].map { |data| new(data) }
+          end
+        when Integer, String
+          new(selector)
+      end
+    end
+
+    class Connector #:nodoc:
+      include HTTParty
+      format :xml
+    end
+
+    # Initializes the connection to the API
+    def self.basic_auth(url, key, token)
+      @key = key # Save this in case they generate a new token later
+      Connector.base_uri(url+"/api")
+      Connector.basic_auth(key, token)
+    end
+
+    def self.key #:nodoc:
+      return @key
+    end
+
+    protected
+    def self.singularized_class_name #:nodoc:
+      ancestors.first.to_s.split('::').last.downcase
+    end
+
+    def self.pluralized_class_name #:nodoc:
+      ancestors.first.to_s.split('::').last.downcase << 's'
+    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 = {}) #:nodoc:
+      handle_response(Connector.send(action, path, :body => options))
+    end
+
+    def self.handle_response(response) #:nodoc:
+      case response.code
+        when 100..199 then
+          response
+        when 200..299 then
+          response
+        when 300.399 then
+          raise(response.messsage)
+        when 400..499 then
+          raise(response.message)
+        when 500..599 then
+          raise(response.message)
+        else
+          raise("Unknown Response")
+      end
+
+    end
+
+
+    # Access attributes as class methods of the Item object
+    def method_missing(method) #:nodoc:
+      return super unless attributes.has_key?(method.to_s)
+      attributes[method.to_s]
+    end
+  end
+end

data/lib/fetchapp-api-ruby/download.rb

@@ -0,0 +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/fetchapp-api-ruby/item.rb

@@ -0,0 +1,55 @@
+module FetchAPI
+  class Item < FetchAPI::Base
+    attr_accessor :id, :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}")
+        @attributes = @attributes[self.class.singularized_class_name]
+      when Hash
+        @attributes = id_or_attributes
+      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
+
+    #--
+    ################# 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
+    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
+end

data/lib/fetchapp-api-ruby/order.rb

@@ -0,0 +1,84 @@
+module FetchAPI
+
+  class Order < FetchAPI::Base
+    attr_accessor :id, :attributes
+
+    #--
+    ################ 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
+        params.merge!(:filter => "current")
+        orders = execute(:get, "/orders", params)
+        if orders["orders"].nil? || orders["orders"].empty?
+          return []
+        else
+          orders["orders"].map { |data| new(data) }
+        end
+      when :manual
+        params.merge!(:filter => "manual")
+        orders = execute(:get, "/orders", params)
+        if orders["orders"].nil? || orders["orders"].empty?
+          return []
+        else
+          orders["orders"].map { |data| new(data) }
+        end
+      when :expired
+        params.merge!(:filter => "expired")
+        orders = execute(:get, "/orders", params)
+        if orders["orders"].nil? || orders["orders"].empty?
+          return []
+        else
+          orders["orders"].map { |data| new(data) }
+        end
+      else
+        super
+      end
+    end
+
+    # Creates a new Order
+    def self.create(options={})
+      return FetchAPI::Order.new(execute(:post, "/orders/create", :order => options)["order"])
+    end
+
+    #--
+    ################# Instance Methods ###############
+    #--
+
+    # Permanently deletes the Order
+    def destroy
+      delete("/orders/#{id}/delete")
+    end
+
+    # Sets the expiration date to Time.now, stopping future downloads
+    def expire
+      post("/orders/#{id}/expire")
+    end
+
+    # Delivers the email containing the download instructions.
+    # Optional params:
+    #   reset_expiration (true/false):  Reset the order's expiration. Defaults to true.
+    #   expiration_date (2009-04-30T15:03:46+00:00): Manually sets the order's expiration date
+    def send_email(options={})
+      post("/orders/#{id}/send_email", options)
+    end
+
+    # 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
+        downloads["downloads"].map { |data| FetchAPI::Download.new(data) }
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: fetchapp-api-ruby
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 4
+  version: 1.2.4
+platform: ruby
+authors: 
+- Michael Larkin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Integrate your site with http://fetchapp.com for seamless digital delivery.
+email: support@fetchapp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/fetchapp-api-ruby/account.rb
+- lib/fetchapp-api-ruby/base.rb
+- lib/fetchapp-api-ruby/download.rb
+- lib/fetchapp-api-ruby/item.rb
+- lib/fetchapp-api-ruby/order.rb
+- lib/fetchapp-api-ruby.rb
+- LICENSE
+- README.md
+files: 
+- CHANGELOG
+- fetchapp-api-ruby.gemspec
+- init.rb
+- lib/fetchapp-api-ruby/account.rb
+- lib/fetchapp-api-ruby/base.rb
+- lib/fetchapp-api-ruby/download.rb
+- lib/fetchapp-api-ruby/item.rb
+- lib/fetchapp-api-ruby/order.rb
+- lib/fetchapp-api-ruby.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/getsy/fetchapp-api-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- fetchapp-api-ruby
+- --main
+- README.md
+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: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 2
+summary: This Ruby library allows you to integrate your site with http://fetchapp.com for seamless digital delivery so you can build additional functionality while retaining the core features of Fetch.  Credit for the bulk of the code goes to Thomas Reynolds.
+test_files: []
+