shopify_api 3.1.6 → 3.1.7

data/CHANGELOG

@@ -1,3 +1,7 @@
+== Version 3.1.7
+
+* Expose `authors` and `tags` action on Article
+
 == Version 3.1.6
 
 * Add LineItem::Property resource

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (3.1.6)
+    shopify_api (3.1.7)
       activeresource (>= 3.0.0)
       thor (>= 0.14.4)
 

data/lib/active_resource/disable_prefix_check.rb

@@ -4,5 +4,19 @@ module DisablePrefixCheck
   module ClassMethods
     def check_prefix_options(options)
     end
+
+    # `flexible = true` is hack to allow multiple things through the same AR class
+    def conditional_prefix(resource, flexible = false)
+      resource_id = "#{resource}_id".to_sym
+      resource_type = flexible ? ":#{resource}" : resource.to_s.pluralize
+
+      init_prefix_explicit resource_type, resource_id
+
+      define_singleton_method :prefix do |options|
+        resource_type =  options[resource] if flexible
+
+        options[resource_id].nil? ? "/admin/" : "/admin/#{resource_type}/#{options[resource_id]}/"
+      end
+    end
   end
 end

data/lib/shopify_api/resources/article.rb

@@ -4,14 +4,18 @@ module ShopifyAPI
     include Metafields
     include DisablePrefixCheck
 
-    self.prefix = "/admin/blogs/:blog_id/"
-     
-    def self.prefix(options={})
-      options[:blog_id].nil? ? "/admin/" : "/admin/blogs/#{options[:blog_id]}/"
-    end
+    conditional_prefix :blog
 
     def comments
       Comment.find(:all, :params => { :article_id => id })
     end
+
+    def self.authors(options = {})
+      get(:authors, options)
+    end
+
+    def self.tags(options={})
+      get(:tags, options)
+    end
   end
 end

data/lib/shopify_api/resources/asset.rb

@@ -35,12 +35,9 @@ module ShopifyAPI
     include DisablePrefixCheck
 
     self.primary_key = 'key'
-    self.prefix = "/admin/themes/:theme_id/"
-    
-    def self.prefix(options={})
-      options[:theme_id].nil? ? "/admin/" : "/admin/themes/#{options[:theme_id]}/"
-    end
-    
+
+    conditional_prefix :theme
+
     def self.element_path(id, prefix_options = {}, query_options = nil) #:nodoc:
       prefix_options, query_options = split_options(prefix_options) if query_options.nil?
       "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"

data/lib/shopify_api/resources/base.rb

@@ -45,6 +45,14 @@ module ShopifyAPI
         self.site = nil
         self.headers.delete('X-Shopify-Access-Token')
       end
+
+      def init_prefix(resource)
+        init_prefix_explicit(resource.to_s.pluralize, "#{resource}_id")
+      end
+
+      def init_prefix_explicit(resource_type, resource_id)
+        self.prefix = "/admin/#{resource_type}/:#{resource_id}/"
+      end
     end
 
     def persisted?

data/lib/shopify_api/resources/event.rb

@@ -2,11 +2,6 @@ module ShopifyAPI
   class Event < Base
     include DisablePrefixCheck
 
-    self.prefix = "/admin/:resource/:resource_id/"
-    
-    # Hack to allow both Shop and other Events in through the same AR class
-    def self.prefix(options={})
-      options[:resource].nil? ? "/admin/" : "/admin/#{options[:resource]}/#{options[:resource_id]}/"
-    end
+    conditional_prefix :resource, true
   end
 end

data/lib/shopify_api/resources/fulfillment.rb

@@ -1,6 +1,6 @@
 module ShopifyAPI
   class Fulfillment < Base
-    self.prefix = "/admin/orders/:order_id/"
+    init_prefix :order
 
     def cancel; load_attributes_from_response(post(:cancel, {}, only_id)); end
     def complete; load_attributes_from_response(post(:complete, {}, only_id)); end

data/lib/shopify_api/resources/image.rb

@@ -1,6 +1,6 @@
 module ShopifyAPI
   class Image < Base
-    self.prefix = "/admin/products/:product_id/"
+    init_prefix :product
     
     # generate a method for each possible image variant
     [:pico, :icon, :thumb, :small, :compact, :medium, :large, :grande, :original].each do |m|

data/lib/shopify_api/resources/metafield.rb

@@ -2,13 +2,8 @@ module ShopifyAPI
   class Metafield < Base
     include DisablePrefixCheck
 
-    self.prefix = "/admin/:resource/:resource_id/"
-    
-    # Hack to allow both Shop and other Metafields in through the same AR class
-    def self.prefix(options={})
-      options[:resource].nil? ? "/admin/" : "/admin/#{options[:resource]}/#{options[:resource_id]}/"
-    end
-            
+    conditional_prefix :resource, true
+
     def value
       return if attributes["value"].nil?
       attributes["value_type"] == "integer" ? attributes["value"].to_i : attributes["value"]

data/lib/shopify_api/resources/province.rb

@@ -1,5 +1,5 @@
 module ShopifyAPI
   class Province < Base
-    self.prefix = "/admin/countries/:country_id/"
+    init_prefix :country
   end
 end

data/lib/shopify_api/resources/transaction.rb

@@ -1,5 +1,5 @@
 module ShopifyAPI
   class Transaction < Base
-    self.prefix = "/admin/orders/:order_id/"
+    init_prefix :order
   end
 end

data/lib/shopify_api/resources/variant.rb

@@ -3,10 +3,6 @@ module ShopifyAPI
     include Metafields
     include DisablePrefixCheck
 
-    self.prefix = "/admin/products/:product_id/"
-    
-    def self.prefix(options={})
-      options[:product_id].nil? ? "/admin/" : "/admin/products/#{options[:product_id]}/"
-    end
+    conditional_prefix :product
   end
 end

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "3.1.6"
+  VERSION = "3.1.7"
 end

data/test/article_test.rb

@@ -25,4 +25,38 @@ class ArticleTest < Test::Unit::TestCase
     article = ShopifyAPI::Article.find(6242736, :params => {:blog_id => 1008414260})
     assert_equal "First Post", article.title
   end
+
+  def test_get_authors
+    fake "articles/authors", :method => :get, :body => load_fixture('authors')
+    authors = ShopifyAPI::Article.authors
+    assert_equal "Shopify", authors.first
+    assert_equal "development shop", authors.last
+  end
+
+  def test_get_authors_for_blog_id
+    fake "blogs/1008414260/articles/authors", :method => :get, :body => load_fixture('authors')
+    authors = ShopifyAPI::Article.authors(:blog_id => 1008414260)
+    assert_equal 3, authors.length
+  end
+
+  def test_get_tags
+    fake "articles/tags", :method => :get, :body => load_fixture('tags')
+    tags = ShopifyAPI::Article.tags
+    assert_equal "consequuntur", tags.first
+    assert_equal "repellendus", tags.last
+  end
+
+  def test_get_tags_for_blog_id
+    fake "blogs/1008414260/articles/tags", :method => :get, :body => load_fixture('tags')
+    tags = ShopifyAPI::Article.tags(:blog_id => 1008414260)
+    assert_equal "consequuntur", tags.first
+    assert_equal "repellendus", tags.last
+  end
+
+  def test_get_popular_tags
+    fake "articles/tags.json?limit=1&popular=1", :extension => false, :method => :get, :body => load_fixture('tags')
+    tags = ShopifyAPI::Article.tags(:popular => 1, :limit => 1)
+    assert_equal 3, tags.length
+  end
+
 end

data/test/fixtures/authors.json

@@ -0,0 +1 @@
+{"authors": ["Shopify", "development shop", "development shop"]}

data/test/fixtures/tags.json

@@ -0,0 +1 @@
+{"tags": ["consequuntur", "cupiditate", "repellendus"]}

data/test/fixtures/transaction.json

@@ -0,0 +1,29 @@
+{
+  "transaction": {
+    "amount": "409.94",
+    "authorization": "authorization-key",
+    "created_at": "2005-08-01T11:57:11-04:00",
+    "gateway": "bogus",
+    "id": 389404469,
+    "kind": "authorization",
+    "location_id": null,
+    "message": null,
+    "order_id": 450789469,
+    "parent_id": null,
+    "status": "success",
+    "test": false,
+    "user_id": null,
+    "device_id": null,
+    "receipt": {
+      "testcase": true,
+      "authorization": "123456"
+    },
+    "payment_details": {
+      "avs_result_code": null,
+      "credit_card_bin": null,
+      "cvv_result_code": null,
+      "credit_card_number": "XXXX-XXXX-XXXX-4242",
+      "credit_card_company": "Visa"
+    }
+  }
+}

data/test/transaction_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class TransactionTest < Test::Unit::TestCase
+  def setup
+    fake "orders/450789469/transactions/389404469", :method => :get, :body => load_fixture('transaction')
+  end
+
+  context "Transaction" do
+    context "#find" do
+      should "find a specific transaction" do
+        transaction = ShopifyAPI::Transaction.find(389404469, :params => {:order_id => 450789469})
+        assert_equal "409.94", transaction.amount
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 3.1.6
+  version: 3.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -186,6 +186,7 @@ files:
 - test/fixtures/articles.json
 - test/fixtures/asset.json
 - test/fixtures/assets.json
+- test/fixtures/authors.json
 - test/fixtures/blog.json
 - test/fixtures/blogs.json
 - test/fixtures/carts.json
@@ -197,6 +198,8 @@ files:
 - test/fixtures/metafields.json
 - test/fixtures/product.json
 - test/fixtures/shop.json
+- test/fixtures/tags.json
+- test/fixtures/transaction.json
 - test/fixtures/variant.json
 - test/fixtures/variants.json
 - test/fulfillment_test.rb
@@ -206,6 +209,7 @@ files:
 - test/session_test.rb
 - test/shop_test.rb
 - test/test_helper.rb
+- test/transaction_test.rb
 - test/variant_test.rb
 homepage: http://www.shopify.com/partners/apps
 licenses:
@@ -223,7 +227,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4375809972843917897
+      hash: 355511341296706903
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -232,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4375809972843917897
+      hash: 355511341296706903
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23