shydra 0.0.1 → 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/lib/shydra.rb

@@ -3,6 +3,10 @@ require "typhoeus"
 require "shopify_api"
 require 'shydra/request'
 require 'shydra/response'
+require 'shydra/resource'
+require 'shydra/resources/product'
+require 'shydra/resources/metafield'
+require 'shydra/resources/variant'
 
 module Shydra
   class << self

data/lib/shydra/request.rb

@@ -11,6 +11,10 @@ module Shydra
       ShopifyAPI::Base.site
     end
 
+    def self.headers
+      ShopifyAPI::Base.headers
+    end
+
     def initialize(*args)
       @options = args.extract_options!
       @count = @options.delete(:count)
@@ -23,18 +27,24 @@ module Shydra
       @resource ||= 'shop'
       @resource = @resource.to_s
 
+      @parent_resource = @options.delete(:parent_resource)
+      @parent_resource, @parent_resource_id = @parent_resource.first if @parent_resource
+
+
       @id = @options.delete(:id)
 
       @options[:limit] ||= SHOPIFY_API_MAX_LIMIT
 
       resource_path = @resource
       resource_path = resource_path.pluralize unless (@resource == 'shop')
+      resource_path = [@parent_resource.to_s.pluralize, @parent_resource_id, resource_path].join('/') if @parent_resource
 
 
       path = [resource_path]
       path.unshift('admin') unless Request.base_uri.path[-1] == '/' #handle quirk of URI.merge
 
-      @data_root = @resource
+      @data_root = nil
+
       if @count
         path << 'count'
         @options.delete(:limit)
@@ -50,7 +60,7 @@ module Shydra
       uri = Request.base_uri.merge(path)
       uri.query = @options.to_param unless @options.empty?
 
-      super(uri.to_s)
+      super(uri.to_s, headers: Request.headers)
     end
 
     def finish(response, bypass_memoization = nil)

data/lib/shydra/resource.rb

@@ -0,0 +1,71 @@
+module Shydra
+  class Resource < Request
+
+    class << self
+      attr_reader :parents
+
+      def has_parents(*args)
+        @parents = args.map(&:to_sym)
+      end
+
+      def parent_keys
+        @parent_keys ||= parents.map{|p| [p, "#{p.to_s}_id".to_sym]}.flatten.unshift(:parent_resource)
+      end
+    end
+
+
+=begin
+    parents can be specified in the following ways:
+
+      --> assume the parent is :product
+      product: 1234
+      product_id: 1234
+      product: {id: 1234, blah}
+      product: ShopifyAPI::Product.find(1234)   #ie, a shopify object
+      parent_resource: {:product => 1234}
+      parent_resource: ShopifyAPI::Product.find(1234)
+=end
+    def initialize(*args)
+      # the class name is the resource
+      args.unshift(self.class.name.demodulize.underscore)
+
+      # if we can be a child resource
+      unless self.class.parents.nil? || self.class.parents.empty?
+        options = args.extract_options!
+
+        # find which parent we have.
+        options.symbolize_keys!
+        parent = options.keys.select{|k| self.class.parent_keys.include?(k)}
+        raise "#{self.class.name} cannot have multiple parents: #{parent.inspect}" if parent.length > 1
+
+        unless parent.empty?
+          parent_id = options.delete(parent.first)
+
+          # user can use parent_resource when parent type can vary at runtime
+          if parent.first == :parent_resource
+          # parent_resource: {product: 123}
+            if parent_id.is_a?(Hash)
+              raise "#{self.class.name} cannot have multiple parents: #{parent_id.inspect}" if parent_id.length > 1
+              parent_key = parent_id.first.first
+              parent_id = parent_id.first.last
+            elsif parent_id.is_a?(ActiveResource::Base)
+            # parent_resource: <ShopifyAPI::Product instance>
+              parent_key = parent_id.class.collection_name.to_sym
+              parent_element = parent_id.class.element_name.to_sym
+              raise "#{parent_id.inspect} cannot be a parent of #{self.class.name}" unless self.class.parents.include?(parent_element)
+              parent_id = parent_id.id
+            end
+          else
+            parent_key = parent.first.to_s.sub(/_id$/,'').to_sym
+            parent_id = parent_id[:id] if parent_id.is_a?(Hash)
+            parent_id = parent_id.id if parent_id.respond_to?(:id)
+          end
+          options.merge!({:parent_resource => {parent_key => parent_id}})
+
+        end
+        args << options
+      end
+      super(*args)
+    end      
+  end
+end

data/lib/shydra/resources/metafield.rb

@@ -0,0 +1,7 @@
+module Shydra
+  module Resources
+    class Metafield < Shydra::Resource
+      has_parents :product, :variant, :blog, :custom_collection, :order, :page, :customer
+    end
+  end
+end

data/lib/shydra/resources/product.rb

@@ -0,0 +1,10 @@
+module Shydra
+  module Resources
+    class Product < Shydra::Request
+      def initialize(*args)
+        args.unshift(:product)
+        super(*args)
+      end      
+    end
+  end
+end

data/lib/shydra/resources/variant.rb

@@ -0,0 +1,7 @@
+module Shydra
+  module Resources
+    class Variant < Shydra::Resource
+      has_parents :product
+    end
+  end
+end

data/lib/shydra/version.rb

@@ -1,3 +1,3 @@
 module Shydra
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/shydra/request_spec.rb

@@ -5,7 +5,9 @@ require 'shydra/request'
 
 describe "Shydra::Request" do
   before do
+    @shopify_headers = {"X-Shopify-Access-Token"=>"yyyyyyyyy"}
      ShopifyAPI::Base.stub(:site).and_return(URI("https://xxxx:yyyy@cronin.myshopify.com/admin/"))
+     ShopifyAPI::Base.stub(:headers).and_return(@shopify_headers)
   end
 
   describe "URIs" do
@@ -18,6 +20,10 @@ describe "Shydra::Request" do
       expect(Shydra::Request.base_uri).to eq(store_uri)
     end
 
+    it "gets headers from Shopify API" do
+      expect(Shydra::Request.new(:product).options[:headers]["X-Shopify-Access-Token"]).to eq("yyyyyyyyy")
+    end
+
     it "creates resource collection uri" do
       expect(Shydra::Request.new(:product).url).to eq(
         store_uri.to_s + "products.json?limit=250")

data/spec/shydra/resource_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe "Shydra::Resource" do
+  it "needs to have tests written"
+end

data/spec/shydra/resources/metafield_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe "Shydra::Resources::Metafield" do
+  it "needs to have tests written"
+end

data/spec/shydra/resources/product_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Shydra::Resources::Product do
+  before do
+     ShopifyAPI::Base.stub(:site).and_return(URI("https://xxxx:yyyy@cronin.myshopify.com/admin/"))
+  end
+
+  let(:store_uri){ URI("https://xxxx:yyyy@cronin.myshopify.com/admin/")}
+
+  it "creates a product request" do
+    expect(Shydra::Resources::Product.new(:product, id: 12345).url).to eq(
+        store_uri.to_s + "products/12345.json?limit=250")
+  end
+end

data/spec/shydra/resources/variant_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Shydra::Resources::Variant do
+  before do
+     ShopifyAPI::Base.stub(:site).and_return(URI("https://xxxx:yyyy@cronin.myshopify.com/admin/"))
+  end
+
+  let(:store_uri){ URI("https://xxxx:yyyy@cronin.myshopify.com/admin/")}
+
+  it "creates a variant request" do
+    expect(Shydra::Resources::Variant.new(id: 12345).url).to eq(
+        store_uri.to_s + "variants/12345.json?limit=250")
+  end
+
+
+  it "creates a product variant request" do
+    expect(Shydra::Resources::Variant.new(product_id: 7777).url).to eq(
+        store_uri.to_s + "products/7777/variants.json?limit=250")
+    expect(Shydra::Resources::Variant.new(product: 7777).url).to eq(
+        store_uri.to_s + "products/7777/variants.json?limit=250")
+    expect(Shydra::Resources::Variant.new(product: {id: 7777}).url).to eq(
+        store_uri.to_s + "products/7777/variants.json?limit=250")
+  end
+
+  it "creates a product variant request from a shopify object" do
+    product = ShopifyAPI::Product.new(id: 888)
+    expect(Shydra::Resources::Variant.new(product: product).url).to eq(
+      store_uri.to_s + "products/888/variants.json?limit=250")
+  end
+
+  it "creates a variant request from a parent_resource" do
+    # expect(Shydra::Resources::Variant.new(parent_resource: {product: 7777}).url).to eq(
+    #     store_uri.to_s + "products/7777/variants.json?limit=250")
+
+    product = ShopifyAPI::Product.new(id: 888)
+    expect(Shydra::Resources::Variant.new(parent_resource: product).url).to eq(
+        store_uri.to_s + "products/888/variants.json?limit=250")
+
+    metafield = ShopifyAPI::Metafield.new(id: 444)
+    expect{Shydra::Resources::Variant.new(parent_resource: metafield)}.to raise_error(
+      /cannot be a parent of/
+    )
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shydra
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -117,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -125,11 +126,19 @@ files:
 - lib/shydra.rb
 - lib/shydra/hydra.rb
 - lib/shydra/request.rb
+- lib/shydra/resource.rb
+- lib/shydra/resources/metafield.rb
+- lib/shydra/resources/product.rb
+- lib/shydra/resources/variant.rb
 - lib/shydra/response.rb
 - lib/shydra/version.rb
 - shydra.gemspec
 - spec/shydra/hydra_spec.rb
 - spec/shydra/request_spec.rb
+- spec/shydra/resource_spec.rb
+- spec/shydra/resources/metafield_spec.rb
+- spec/shydra/resources/product_spec.rb
+- spec/shydra/resources/variant_spec.rb
 - spec/shydra/response_spec.rb
 - spec/shydra_spec.rb
 - spec/spec_helper.rb
@@ -148,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1355709900760715495
+      hash: -2036902327160108675
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1355709900760715495
+      hash: -2036902327160108675
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -167,6 +176,10 @@ summary: A fast, parallel shopify api client using typhoeus/hydraa
 test_files:
 - spec/shydra/hydra_spec.rb
 - spec/shydra/request_spec.rb
+- spec/shydra/resource_spec.rb
+- spec/shydra/resources/metafield_spec.rb
+- spec/shydra/resources/product_spec.rb
+- spec/shydra/resources/variant_spec.rb
 - spec/shydra/response_spec.rb
 - spec/shydra_spec.rb
 - spec/spec_helper.rb