shopify_api 1.2.5 → 2.0.0

data/shopify_api.gemspec

@@ -2,105 +2,27 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shopify_api}
-  s.version = "1.2.5"
+  s.version = "2.0.0"
+  s.author = "Shopify"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Tobias L\303\274tke", "Cody Fauser", "Dennis Theisen", "Edward Ocampo-Gooding"]
-  s.date = %q{2010-10-05}
-  s.description = %q{= Shopify API
-
-The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
-
-The API is implemented as XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we've tried to make the API follow the REST principles as much as possible.
-
-
-== Usage
-
-=== Requirements
-
-All API usage happens through Shopify applications, created by either shop owners for their own shops, or by Shopify Partners for use by other shop owners:
-
-* Shop owners can create applications for themselves through their own admin (under the Preferences > Applications tab).
-* Shopify Partners create applications through their admin: http://app.shopify.com/services/partners 
-
-For more information and detailed documentation about the API visit http://api.shopify.com
-
-=== Getting Started
-
-ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveResource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:
-
-1. First create a new application in either the partners admin or your store admin and write down your API_KEY and SHARED_SECRET.
-
-2. You will need to supply two parameters to the Session class before you instantiate it:
-
-    ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})
-
-3. Create a new Session for a specific shop. That session is not fully valid yet, but it can be used to create a URL that you will redirect your users to:
-
-    session = ShopifyAPI::Session.new("yourshopname.myshopify.com")
-    session.valid?  # returns false
-
-4. To access the API shop owners need a "token" from that specific shop. In order to get this token they need to authorize with that shop first. The URL to redirect your user to can be generated via:
-
-    url = session.create_permission_url
-
-5. After visiting this URL, the shop redirects the owner to a custom URL of your application where the "token" gets sent to (it's param name is just "t"). Use that token to instantiate a "valid" session, that is ready to make calls to that particular shop.
-
-    token = params[:t]
-    session = ShopifyAPI::Session.new("yourshopname.myshopify.com", token)
-    session.valid?  # returns true
-
-6. Now you can finally get the fully authorized URL for that shop. Use that URL to configure ActiveResource and you're set:
-
-     ActiveResource::Base.site = session.site
-
-7. Get data from that shop (returns ActiveResource instances):
-
-     shop = ShopifyAPI::Shop.current
-     latest_orders = ShopifyAPI::Order.find(:all)
-
-== Copyright
-
-Copyright (c) 2009 "JadedPixel inc.". See LICENSE for details.
-}
+  s.summary = %q{The Shopify API gem is a lightweight gem for accessing the Shopify admin REST web services}
+  s.description = %q{The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores. The API is implemented as JSON or XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation.}
   s.email = %q{developers@jadedpixel.com}
+  s.homepage = %q{http://www.shopify.com/partners/apps}
+
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "CHANGELOG",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "lib/shopify_api.rb",
-     "lib/shopify_api/cli.rb",
-     "shopify_api.gemspec",
-     "test/order_test.rb",
-     "test/shopify_api_test.rb",
-     "test/test_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/Shopify/shopify_api}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
   s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{shopify-api}
-  s.rubygems_version = %q{1.3.7}
   s.summary = %q{ShopifyAPI is a lightweight gem for accessing the Shopify admin REST web services}
-  s.test_files = [
-    "test/order_test.rb",
-     "test/shopify_api_test.rb",
-     "test/test_helper.rb"
-  ]
-  s.executables = ['shopify']
+  s.license = 'MIT'
 
-  if s.respond_to? :specification_version
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-  end
-  
-  s.add_dependency("activeresource", [">= 2.2.2"])
+  s.add_dependency("activeresource", [">= 3.0.0"])
   s.add_dependency("thor", [">= 0.14.4"])
   
   if s.respond_to?(:add_development_dependency)
@@ -109,4 +31,3 @@ Copyright (c) 2009 "JadedPixel inc.". See LICENSE for details.
     s.add_dependency("mocha", ">= 0.9.8")
   end
 end
-

data/test/cli_test.rb

@@ -0,0 +1,109 @@
+require 'test_helper'
+require 'shopify_api/cli'
+require 'fileutils'
+
+class CliTest < Test::Unit::TestCase
+  def setup
+    @test_home = File.join(File.expand_path(File.dirname(__FILE__)), 'files', 'home')
+    @shop_config_dir = File.join(@test_home, '.shopify', 'shops')
+    @default_symlink = File.join(@shop_config_dir, 'default')
+    `rm -rf #{@test_home}`
+    ENV['HOME'] = @test_home
+    @cli = ShopifyAPI::Cli.new
+    
+    FileUtils.mkdir_p(@shop_config_dir)
+    File.open(config_file('foo'), 'w') do |file|
+      file.puts valid_options.merge('domain' => 'foo.myshopify.com').to_yaml
+    end
+    File.symlink(config_file('foo'), @default_symlink)
+    File.open(config_file('bar'), 'w') do |file|
+      file.puts valid_options.merge('domain' => 'bar.myshopify.com').to_yaml
+    end
+  end
+  
+  def teardown
+    `rm -rf #{@test_home}`
+  end
+  
+  test "add with blank domain" do
+    `rm -rf #{@shop_config_dir}/*`
+    $stdout.expects(:print).with("Domain? (leave blank for foo.myshopify.com) ")
+    $stdout.expects(:print).with("API key? ")
+    $stdout.expects(:print).with("Password? ")
+    $stdin.expects(:gets).times(3).returns("", "key", "pass")
+    @cli.expects(:puts).with("\nopen https://foo.myshopify.com/admin/api in your browser to get API credentials\n")
+    @cli.expects(:puts).with("Default connection is foo")
+    
+    @cli.add('foo')
+    
+    config = YAML.load(File.read(config_file('foo')))
+    assert_equal 'foo.myshopify.com', config['domain']
+    assert_equal 'key', config['api_key']
+    assert_equal 'pass', config['password']
+    assert_equal 'https', config['protocol']
+    assert_equal config_file('foo'), File.readlink(@default_symlink)
+  end
+  
+  test "add with explicit domain" do
+    `rm -rf #{@shop_config_dir}/*`
+    $stdout.expects(:print).with("Domain? (leave blank for foo.myshopify.com) ")
+    $stdout.expects(:print).with("API key? ")
+    $stdout.expects(:print).with("Password? ")
+    $stdin.expects(:gets).times(3).returns("bar.myshopify.com", "key", "pass")
+    @cli.expects(:puts).with("\nopen https://bar.myshopify.com/admin/api in your browser to get API credentials\n")
+    @cli.expects(:puts).with("Default connection is foo")
+    
+    @cli.add('foo')
+    
+    config = YAML.load(File.read(config_file('foo')))
+    assert_equal 'bar.myshopify.com', config['domain']
+  end
+  
+  test "list" do
+    @cli.expects(:puts).with("   bar")
+    @cli.expects(:puts).with(" * foo")
+    
+    @cli.list
+  end
+  
+  test "show default" do
+    @cli.expects(:puts).with("Default connection is foo")
+    
+    @cli.default
+  end
+  
+  test "set default" do
+    @cli.expects(:puts).with("Default connection is bar")
+    
+    @cli.default('bar')
+    
+    assert_equal config_file('bar'), File.readlink(@default_symlink)
+  end
+  
+  test "remove default connection" do
+    @cli.remove('foo')
+    
+    assert !File.exist?(@default_symlink)
+    assert !File.exist?(config_file('foo'))
+    assert File.exist?(config_file('bar'))
+  end
+  
+  test "remove non-default connection" do
+    @cli.remove('bar')
+    
+    assert_equal config_file('foo'), File.readlink(@default_symlink)
+    assert File.exist?(config_file('foo'))
+    assert !File.exist?(config_file('bar'))
+  end
+  
+  private
+  
+  def valid_options
+    {'domain' => 'snowdevil.myshopify.com', 'api_key' => 'key', 'password' => 'pass', 'protocol' => 'https'}
+  end
+  
+  def config_file(connection)
+    File.join(@shop_config_dir, "#{connection}.yml")
+  end
+  
+end

data/test/limits_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+require 'mocha'
+
+class LimitsTest < Test::Unit::TestCase
+  def setup
+    ShopifyAPI::Base.site = "test.myshopify.com"
+    @header_hash = {'http_x_shopify_api_call_limit' => '150/3000',
+                    'http_x_shopify_shop_api_call_limit' => '100/300'}
+    ShopifyAPI::Base.connection.expects(:response).at_least(0).returns(@header_hash)
+  end
+  
+  context "Limits" do
+    should "fetch limit total" do
+      assert_equal(299, ShopifyAPI.credit_limit(:shop))
+      assert_equal(2999, ShopifyAPI.credit_limit(:global))
+    end
+    
+    should "fetch used calls" do
+      assert_equal(100, ShopifyAPI.credit_used(:shop))
+      assert_equal(150, ShopifyAPI.credit_used(:global))
+    end
+    
+    should "calculate remaining calls" do
+      assert_equal(199, ShopifyAPI.credit_left)
+    end
+    
+    should "flag maxed out credits" do
+      assert !ShopifyAPI.maxed?
+      @header_hash = {'http_x_shopify_api_call_limit' => '2999/3000',
+                      'http_x_shopify_shop_api_call_limit' => '299/300'}
+      ShopifyAPI::Base.connection.expects(:response).at_least(1).returns(@header_hash)
+      assert ShopifyAPI.maxed?
+    end
+  end
+  
+  
+end

data/test/shopify_api_test.rb

@@ -39,5 +39,17 @@ class ShopifyApiTest < Test::Unit::TestCase
     should "use 'https' protocol by default for all sessions" do
       assert_equal 'https', ShopifyAPI::Session.protocol
     end
+
+    should "#temp reset ShopifyAPI::Base.site to original value" do
+      ShopifyAPI::Base.site = 'http://www.original.com'
+
+      ShopifyAPI::Session.setup(:api_key => "key", :secret => "secret")
+      assigned_site = nil
+      ShopifyAPI::Session.temp("testshop.myshopify.com", "any-token") {
+        assigned_site = ShopifyAPI::Base.site
+      }
+      assert_equal 'https://key:e56d5793b869753d87cf03ceb6bb5dfc@testshop.myshopify.com/admin', assigned_site.to_s
+      assert_equal 'http://www.original.com', ShopifyAPI::Base.site.to_s
+    end
   end
-end
+end

metadata

@@ -1,24 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: shopify_api
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
-  - 1
   - 2
-  - 5
-  version: 1.2.5
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
-- "Tobias L\xC3\xBCtke"
-- Cody Fauser
-- Dennis Theisen
-- Edward Ocampo-Gooding
+- Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-10-05 00:00:00 -04:00
-default_executable: 
+date: 2011-09-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activeresource
@@ -28,11 +25,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
-        - 2
-        - 2
-        - 2
-        version: 2.2.2
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,6 +41,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 47
         segments: 
         - 0
         - 14
@@ -58,6 +57,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
         - 9
@@ -65,63 +65,7 @@ dependencies:
         version: 0.9.8
   type: :development
   version_requirements: *id003
-description: |
-  = Shopify API
-  
-  The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
-  
-  The API is implemented as XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we've tried to make the API follow the REST principles as much as possible.
-  
-  
-  == Usage
-  
-  === Requirements
-  
-  All API usage happens through Shopify applications, created by either shop owners for their own shops, or by Shopify Partners for use by other shop owners:
-  
-  * Shop owners can create applications for themselves through their own admin (under the Preferences > Applications tab).
-  * Shopify Partners create applications through their admin: http://app.shopify.com/services/partners 
-  
-  For more information and detailed documentation about the API visit http://api.shopify.com
-  
-  === Getting Started
-  
-  ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveResource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:
-  
-  1. First create a new application in either the partners admin or your store admin and write down your API_KEY and SHARED_SECRET.
-  
-  2. You will need to supply two parameters to the Session class before you instantiate it:
-  
-      ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})
-  
-  3. Create a new Session for a specific shop. That session is not fully valid yet, but it can be used to create a URL that you will redirect your users to:
-  
-      session = ShopifyAPI::Session.new("yourshopname.myshopify.com")
-      session.valid?  # returns false
-  
-  4. To access the API shop owners need a "token" from that specific shop. In order to get this token they need to authorize with that shop first. The URL to redirect your user to can be generated via:
-  
-      url = session.create_permission_url
-  
-  5. After visiting this URL, the shop redirects the owner to a custom URL of your application where the "token" gets sent to (it's param name is just "t"). Use that token to instantiate a "valid" session, that is ready to make calls to that particular shop.
-  
-      token = params[:t]
-      session = ShopifyAPI::Session.new("yourshopname.myshopify.com", token)
-      session.valid?  # returns true
-  
-  6. Now you can finally get the fully authorized URL for that shop. Use that URL to configure ActiveResource and you're set:
-  
-       ActiveResource::Base.site = session.site
-  
-  7. Get data from that shop (returns ActiveResource instances):
-  
-       shop = ShopifyAPI::Shop.current
-       latest_orders = ShopifyAPI::Order.find(:all)
-  
-  == Copyright
-  
-  Copyright (c) 2009 "JadedPixel inc.". See LICENSE for details.
-
+description: The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores. The API is implemented as JSON or XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation.
 email: developers@jadedpixel.com
 executables: 
 - shopify
@@ -136,18 +80,68 @@ files:
 - CHANGELOG
 - LICENSE
 - README.rdoc
+- RELEASING
 - Rakefile
+- bin/shopify
+- lib/active_resource/connection_ext.rb
 - lib/shopify_api.rb
 - lib/shopify_api/cli.rb
+- lib/shopify_api/countable.rb
+- lib/shopify_api/events.rb
+- lib/shopify_api/json_format.rb
+- lib/shopify_api/limits.rb
+- lib/shopify_api/metafields.rb
+- lib/shopify_api/resources.rb
+- lib/shopify_api/resources/address.rb
+- lib/shopify_api/resources/application_charge.rb
+- lib/shopify_api/resources/article.rb
+- lib/shopify_api/resources/asset.rb
+- lib/shopify_api/resources/base.rb
+- lib/shopify_api/resources/billing_address.rb
+- lib/shopify_api/resources/blog.rb
+- lib/shopify_api/resources/collect.rb
+- lib/shopify_api/resources/comment.rb
+- lib/shopify_api/resources/country.rb
+- lib/shopify_api/resources/custom_collection.rb
+- lib/shopify_api/resources/customer.rb
+- lib/shopify_api/resources/customer_group.rb
+- lib/shopify_api/resources/event.rb
+- lib/shopify_api/resources/fulfillment.rb
+- lib/shopify_api/resources/image.rb
+- lib/shopify_api/resources/line_item.rb
+- lib/shopify_api/resources/metafield.rb
+- lib/shopify_api/resources/note_attribute.rb
+- lib/shopify_api/resources/option.rb
+- lib/shopify_api/resources/order.rb
+- lib/shopify_api/resources/page.rb
+- lib/shopify_api/resources/payment_details.rb
+- lib/shopify_api/resources/product.rb
+- lib/shopify_api/resources/product_search_engine.rb
+- lib/shopify_api/resources/province.rb
+- lib/shopify_api/resources/receipt.rb
+- lib/shopify_api/resources/recurring_application_charge.rb
+- lib/shopify_api/resources/redirect.rb
+- lib/shopify_api/resources/rule.rb
+- lib/shopify_api/resources/script_tag.rb
+- lib/shopify_api/resources/shipping_address.rb
+- lib/shopify_api/resources/shipping_line.rb
+- lib/shopify_api/resources/shop.rb
+- lib/shopify_api/resources/smart_collection.rb
+- lib/shopify_api/resources/tax_line.rb
+- lib/shopify_api/resources/theme.rb
+- lib/shopify_api/resources/transaction.rb
+- lib/shopify_api/resources/variant.rb
+- lib/shopify_api/resources/webhook.rb
+- lib/shopify_api/session.rb
 - shopify_api.gemspec
+- test/cli_test.rb
+- test/limits_test.rb
 - test/order_test.rb
 - test/shopify_api_test.rb
 - test/test_helper.rb
-- bin/shopify
-has_rdoc: true
-homepage: http://github.com/Shopify/shopify_api
-licenses: []
-
+homepage: http://www.shopify.com/partners/apps
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -158,6 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -166,17 +161,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
-rubyforge_project: shopify-api
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: ShopifyAPI is a lightweight gem for accessing the Shopify admin REST web services
-test_files: 
-- test/order_test.rb
-- test/shopify_api_test.rb
-- test/test_helper.rb
+test_files: []
+