storesapp-rb 0.0.7 → 0.0.8

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Next Feature
+Copyright (c) 2010, Next Feature
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -1,11 +1,17 @@
 lib/storesapp/base.rb
-lib/storesapp/cart.rb
-lib/storesapp/cart_line_item.rb
-lib/storesapp/collection.rb
-lib/storesapp/collection_product.rb
-lib/storesapp/page.rb
-lib/storesapp/product.rb
-lib/storesapp/store.rb
+lib/storesapp/stores_app_resource.rb
+lib/storesapp/resources/cart.rb
+lib/storesapp/resources/cart_item.rb
+lib/storesapp/resources/cart_item_property.rb
+lib/storesapp/resources/collection.rb
+lib/storesapp/resources/collection_product.rb
+lib/storesapp/resources/page.rb
+lib/storesapp/resources/product.rb
+lib/storesapp/resources/product_image.rb
+lib/storesapp/resources/product_property.rb
+lib/storesapp/resources/product_property_value.rb
+lib/storesapp/resources/product_variant.rb
+lib/storesapp/resources/user.rb
 lib/storesapp.rb
-MIT-LICENSE
-README
+LICENSE
+README.markdown

data/README.markdown

@@ -0,0 +1,58 @@
+# storesapp-rb #
+
+A ruby library wrapping the StoresApp API.
+
+## Description ##
+
+This library uses ActiveResource to provide simple, reliable access to the StoresApp API. Good for building eCommerce websites.
+
+## Usage ##
+
+### Creating a new StoresApp object: ###
+
+All calls to the StoresApp API will originate from a StoresApp object. Initialize it like so:
+
+`@store = StoresApp(:api_key => "12340987asdf12340987qwer", :sub_domain => "joeandcompany")`
+                     
+### Collections ###
+
+Index
+
+  `@store.collections.find(:all)`
+
+Show
+
+  `@store.collections.find(43235) # ID`
+
+  `@store.collections.find('clothing') # Handle`
+
+Create
+
+  `@collection = @store.collection.new`
+
+  `@collection.attributes = {:name => "Toys", :description => "lorem ipsum..."}`
+
+  `@collection.save`
+
+Update
+
+  `@collection.name = "Adult Toys"`
+
+  `@collection.save`
+
+Destroy
+
+  `@client.destroy`
+ 
+## Features / Problems ##
+
+Supports most of the StoresApp API (http://api.storesapp.com).
+
+## Requirements ##
+
+Requires active_support >= 2.3.5
+Requires active_resource >= 2.3.5
+
+## Install ##
+  
+  `gem install storesapp-rb`

data/lib/storesapp.rb

@@ -1,13 +1,34 @@
-require 'activesupport'
-require 'activeresource'
-
-$:.unshift(File.dirname(__FILE__))
-
-require 'storesapp/base'
-require 'storesapp/store'
-# require 'storesapp/cart'
-# require 'storesapp/cart_line_item'
-require 'storesapp/collection'
-require 'storesapp/collection_product'
-require 'storesapp/product'
-require 'storesapp/page'
+module StoresApp
+  VERSION   = "0.0.8"
+  ApiDomain = "storesapp.com"
+  
+  # Class method to load all ruby files from a given path.
+  def self.load_all_ruby_files_from_path(path)
+    Dir.foreach(path) do |file|
+      require File.join(path, file) if file =~ /\.rb$/
+    end
+  end  
+end
+
+# Gems
+require "rubygems"
+require "activesupport"
+require "activeresource"
+
+# Plugins
+PluginPath = File.join(File.dirname(__FILE__), "storesapp", "plugins")
+StoresApp.load_all_ruby_files_from_path(PluginPath)
+
+# Base
+require File.join(File.dirname(__FILE__), "storesapp", "base")
+require File.join(File.dirname(__FILE__), "storesapp", "stores_app_resource")
+
+# Shortcut for Harvest::Base.new
+#
+# Example:
+# StoresApp(:api_key  => "asdf1234", 
+#         :sub_domain => "myhostname",
+#         :headers    => {"User-Agent => "Harvest Rubygem"})
+def StoresApp(options={})
+  StoresApp::Base.new(options)
+end

data/lib/storesapp/base.rb

@@ -1,4 +1,65 @@
 module StoresApp
-  class Base < ActiveResource::Base
+  class Base
+    # Requires a sub_domain, and api_key.
+    # Specifying headers is optional, but useful for setting a user agent.
+    def initialize(options={})
+      options.assert_valid_keys(:api_key, :sub_domain, :headers)
+      options.assert_required_keys(:api_key, :sub_domain)
+      @api_key      = options[:api_key]
+      @sub_domain   = options[:sub_domain]
+      @headers      = options[:headers]
+      configure_base_resource
+    end
+    
+    def collections
+      StoresApp::Resources::Collection
+    end
+    
+    def pages
+      StoresApp::Resources::Page
+    end
+    
+    def products
+      StoresApp::Resources::Product
+    end
+    
+    def product_images
+      StoresApp::Resources::ProductImage
+    end
+    
+    def product_properties
+      StoresApp::Resources::ProductProperty
+    end
+    
+    def product_property_values
+      StoresApp::Resources::ProductPropertyValue
+    end
+    
+    def product_variants
+      StoresApp::Resources::ProductVariant
+    end
+
+    def users
+      StoresApp::Resources::User
+    end
+    
+    private
+      # Configure resource base class so that 
+      # inherited classes can access the api.
+      def configure_base_resource
+        StoresAppResource.site     = "http://#{@sub_domain}.#{StoresApp::ApiDomain}/api/v1"
+        if @api_key
+          StoresAppResource.user     = @api_key
+          StoresAppResource.password = 'x'
+        end
+        StoresAppResource.headers.update(@headers) if @headers.is_a?(Hash)
+        load_resources
+      end
+      
+      # Load the classes representing the various resources.
+      def load_resources
+        resource_path = File.join(File.dirname(__FILE__), "resources")
+        StoresApp.load_all_ruby_files_from_path(resource_path)
+      end
   end
 end

data/lib/storesapp/plugins/active_resource_inheritable_headers.rb

@@ -0,0 +1,32 @@
+# Allows headers in an ActiveResource::Base class
+# to be inherited by subclasses.  Useful for setting
+# a User-Agent used by all resources.
+module Harvest
+  module Plugins
+    module ActiveResourceInheritableHeaders
+      module ClassMethods
+        # If headers are not defined in a
+        # given subclass, then obtain headers
+        # from the superclass.
+        def inheritable_headers
+          if defined?(@headers)
+            @headers
+          elsif superclass != Object && superclass.headers
+            superclass.headers
+          else
+            @headers ||= {}
+          end
+        end        
+      end
+      
+      def self.included(klass)
+        klass.instance_eval do
+          klass.extend ClassMethods
+          class << self
+            alias_method :headers, :inheritable_headers
+          end
+        end
+      end
+    end
+  end
+end

data/lib/storesapp/plugins/hash_ext.rb

@@ -0,0 +1,11 @@
+class Hash
+  def assert_valid_keys(*valid_keys)
+    invalid_keys = keys - valid_keys
+    raise ArgumentError, "Invalid key(s): #{invalid_keys.join(", ")}" unless invalid_keys.empty?
+  end
+
+  def assert_required_keys(*required_keys)
+    missing_keys = required_keys.select {|key| !keys.include?(key)}
+    raise ArgumentError, "Missing required option(s): #{missing_keys.join(", ")}" unless missing_keys.empty?
+  end
+end

data/lib/storesapp/resources/cart.rb

@@ -0,0 +1,9 @@
+module StoresApp
+  module Resources
+    class Cart < StoresApp::StoresAppResource
+      def items
+        CartItem.find(:all, :from => "/api/carts/#{self.id}/items.xml")
+      end
+    end
+  end
+end

data/lib/storesapp/resources/cart_item.rb

@@ -0,0 +1,9 @@
+module StoresApp
+  module Resources
+    class CartItem < StoresApp::StoresAppResource
+      def properties
+        CartItemProperty.find(:all, :from => "/api/cart_items/#{self.id}/properties.xml", :params => {:cart_id => self.cart_id})
+      end
+    end
+  end
+end

data/lib/storesapp/resources/cart_item_property.rb

@@ -0,0 +1,6 @@
+module StoresApp
+  module Resources
+    class CartItemProperty < StoresApp::StoresAppResource
+    end
+  end
+end

data/lib/storesapp/resources/collection.rb

@@ -0,0 +1,29 @@
+module StoresApp
+  module Resources
+    class Collection < StoresApp::StoresAppResource
+      def products
+        Product.find(:all, :from => "/api/collections/#{self.id}/products.xml")
+      end
+      
+      # def add_product(options={})
+      #   # options.assert_valid_keys(:product_id)
+      #   # options.assert_required_keys(:product_id)
+      #   put(:add_product, :params => options)
+      # end
+      
+      # def remove_product(options={})
+      #   # options.assert_valid_keys(:product_id)
+      #   # options.assert_required_keys(:product_id)
+      #   put(:remove_product, :prarams => options)
+      # end
+      
+      # def enable
+      #   put(:enable)
+      # end
+      
+      # def disable
+      #   put(:disable)
+      # end
+    end
+  end
+end

data/lib/storesapp/resources/collection_product.rb

@@ -0,0 +1,6 @@
+module StoresApp
+  module Resources
+    class CollectionProduct < StoresApp::StoresAppResource
+    end
+  end
+end

data/lib/storesapp/resources/page.rb

@@ -0,0 +1,6 @@
+module StoresApp
+  module Resources
+    class Page < StoresApp::StoresAppResource
+    end
+  end
+end

data/lib/storesapp/resources/product.rb

@@ -0,0 +1,41 @@
+module StoresApp
+  module Resources
+    class Product < StoresApp::StoresAppResource
+      def collections
+        Collection.find(:all, :from => "/api/products/#{self.id}/collections.xml")
+      end
+      
+      def images
+        ProductImage.find(:all, :from => "/api/products/#{self.id}/images.xml")
+      end
+      
+      def properties
+        ProductProperty.find(:all, :from => "/api/products/#{self.id}/properties.xml")
+      end
+      
+      def variants
+        ProductVariant.find(:all, :from => "/api/products/#{self.id}/variants.xml")
+      end
+
+      # def add_collection(options={})
+      #   # options.assert_valid_keys(:collection_id)
+      #   # options.assert_required_keys(:collection_id)
+      #   put(:add_collection, :params => options)
+      # end
+      
+      # def remove_collection(options={})
+      #   # options.assert_valid_keys(:collection_id)
+      #   # options.assert_required_keys(:collection_id)
+      #   put(:remove_collection, :prarams => options)
+      # end
+      
+      # def enable
+      #   put(:enable)
+      # end
+      # 
+      # def disable
+      #   put(:disable)
+      # end
+    end
+  end
+end

data/lib/storesapp/resources/product_image.rb

@@ -0,0 +1,6 @@
+module StoresApp
+  module Resources
+    class ProductImage < StoresApp::StoresAppResource
+    end
+  end
+end

data/lib/storesapp/resources/product_property.rb

@@ -0,0 +1,9 @@
+module StoresApp
+  module Resources
+    class ProductProperty < StoresApp::StoresAppResource
+      def values
+        ProductPropertyValue.find(:all, :from => "/api/product_properties/#{self.id}/values.xml", :params => {:product_id => self.product_id})
+      end
+    end
+  end
+end

data/lib/storesapp/resources/product_property_value.rb

@@ -0,0 +1,6 @@
+module StoresApp
+  module Resources
+    class ProductPropertyValue < StoresApp::StoresAppResource
+    end
+  end
+end

data/lib/storesapp/resources/product_variant.rb

@@ -0,0 +1,9 @@
+module StoresApp
+  module Resources
+    class ProductVariant < StoresApp::StoresAppResource
+      def values
+        ProductPropertyValue.find(:all, :from => "/api/product_variants/#{self.id}/values.xml", :params => {:product_id => self.product_id})
+      end
+    end
+  end
+end

data/lib/storesapp/resources/user.rb

@@ -0,0 +1,6 @@
+module StoresApp
+  module Resources
+    class User < StoresApp::StoresAppResource
+    end
+  end
+end

data/lib/storesapp/stores_app_resource.rb

@@ -0,0 +1,5 @@
+module StoresApp
+  class StoresAppResource < ActiveResource::Base
+    include Harvest::Plugins::ActiveResourceInheritableHeaders
+  end
+end

data/storesapp.gemspec

@@ -2,21 +2,18 @@
 # encoding: utf-8
 
 Gem::Specification.new do |s|
-  s.name = "storesapp-rb"
-  s.version = "0.0.7"
-  s.authors = ["Next Feature"]
-  s.homepage = "http://github.com/nextfeature/storesapp-rb"
-  s.summary = "Ruby Gem for accessing the StoresApp API."
-  s.description = s.summary
-  s.cert_chain = nil
-  s.email = ["info@nextfeature.com"]
-  s.has_rdoc = false
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.1") if s.respond_to?(:required_rubygems_version=)
-  s.rubygems_version = %q{1.3.1}
-  s.required_ruby_version = Gem::Requirement.new("~> 1.8")
-  s.files = `git ls-files`.split("\n")
+  s.name        = "storesapp-rb"
+  s.version     = "0.0.8"
+  s.authors     = ["Next Feature"]
+  s.summary     = "A wrapper for the StoresApp Api.  See http://api.storesapp.com for details."
+  s.date        = Date.today.to_s
+  # s.description = s.summary
+  s.homepage    = "http://github.com/nextfeature/storesapp-rb"
+  s.email       = ["info@nextfeature.com"]
+  s.files       = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
-  s.add_dependency(%q<activesupport>, [">= 2.3.5"])
-  s.add_dependency(%q<activeresource>, [">= 2.3.5"])
+  # s.test_files = [""]
+  s.has_rdoc = false
+  s.add_dependency("activesupport", [">= 2.3.5"])
+  s.add_dependency("activeresource", [">= 2.3.5"])
 end

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: storesapp-rb
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Next Feature
 autorequire: 
 bindir: bin
-cert_chain: 
-date: 2010-06-02 00:00:00 -04:00
+cert_chain: []
+
+date: 2010-06-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,7 +50,7 @@ dependencies:
         version: 2.3.5
   type: :runtime
   version_requirements: *id002
-description: Ruby Gem for accessing the StoresApp API.
+description: 
 email: 
 - info@nextfeature.com
 executables: []
@@ -60,18 +61,26 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- MIT-LICENSE
+- LICENSE
 - Manifest.txt
-- README
+- README.markdown
 - lib/storesapp.rb
 - lib/storesapp/base.rb
-- lib/storesapp/cart.rb
-- lib/storesapp/cart_line_item.rb
-- lib/storesapp/collection.rb
-- lib/storesapp/collection_product.rb
-- lib/storesapp/page.rb
-- lib/storesapp/product.rb
-- lib/storesapp/store.rb
+- lib/storesapp/plugins/active_resource_inheritable_headers.rb
+- lib/storesapp/plugins/hash_ext.rb
+- lib/storesapp/resources/cart.rb
+- lib/storesapp/resources/cart_item.rb
+- lib/storesapp/resources/cart_item_property.rb
+- lib/storesapp/resources/collection.rb
+- lib/storesapp/resources/collection_product.rb
+- lib/storesapp/resources/page.rb
+- lib/storesapp/resources/product.rb
+- lib/storesapp/resources/product_image.rb
+- lib/storesapp/resources/product_property.rb
+- lib/storesapp/resources/product_property_value.rb
+- lib/storesapp/resources/product_variant.rb
+- lib/storesapp/resources/user.rb
+- lib/storesapp/stores_app_resource.rb
 - storesapp.gemspec
 has_rdoc: true
 homepage: http://github.com/nextfeature/storesapp-rb
@@ -85,30 +94,27 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ~>
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 31
+      hash: 3
       segments: 
-      - 1
-      - 8
-      version: "1.8"
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby Gem for accessing the StoresApp API.
+summary: A wrapper for the StoresApp Api.  See http://api.storesapp.com for details.
 test_files: []
 

data/README

@@ -1 +0,0 @@
-StoresApp-rb

data/lib/storesapp/cart.rb

@@ -1,7 +0,0 @@
-module StoresApp
-  class Cart < Base
-    # def line_items
-    #   CartLineItem.find(:all, :from => "/cart/#{number}/line_items.xml")
-    # end
-  end
-end

data/lib/storesapp/cart_line_item.rb

@@ -1,7 +0,0 @@
-module StoresApp
-  class CartLineItem < Base
-    # def cart
-    #   Cart.find(:one, :from => "/cart/#{number}.xml")
-    # end
-  end
-end

data/lib/storesapp/collection.rb

@@ -1,11 +0,0 @@
-module StoresApp
-  class Collection < Base
-    def collection_products
-      CollectionProduct.find(:all).select {|cp| cp.collection_id == id}
-    end
-
-    def products
-      Product.find(:all).select {|p| collection_products.collect {|cp| cp.product_id}.include?(p.id)}
-    end
-  end
-end

data/lib/storesapp/collection_product.rb

@@ -1,4 +0,0 @@
-module StoresApp
-  class CollectionProduct < Base
-  end
-end

data/lib/storesapp/page.rb

@@ -1,4 +0,0 @@
-module StoresApp
-  class Page < Base
-  end
-end

data/lib/storesapp/product.rb

@@ -1,11 +0,0 @@
-module StoresApp
-  class Product < Base
-    def collection_products
-      CollectionProduct.find(:all).select {|cp| cp.product_id == id}
-    end
-
-    def collections
-      Collection.find(:all).select {|c| collection_products.collect {|cp| cp.collection_id}.include?(c.id)}
-    end
-  end
-end

data/lib/storesapp/store.rb

@@ -1,15 +0,0 @@
-module StoresApp
-  class Store < Base
-    # def collections
-    #   Collection.find(:all, :from => "/collections.xml")
-    # end
-    # 
-    # def pages
-    #   Page.find(:all, :from => "/pages.xml")
-    # end
-    # 
-    # def products
-    #   Product.find(:all, :from => "/products.xml")
-    # end
-  end
-end