shopify_api 5.2.4 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ec95eea11639a4bb5808aca547e3bf8cb26fb1d3cb1c7576949d99670932fe
-  data.tar.gz: f0d6932da38d82ae6685006ff7683f4a6767f343ca344fbced06fdbfdb9cb51a
+  metadata.gz: 7b0ab297c1e32ac84d673b04ddf366cc5f9d43f2eb6f060d70e5d1fcc7c8736f
+  data.tar.gz: 99a2583bf370e73c85f2b71c4b6e99f1ac2e37db2a628a30dcbed346c29bdf8a
 SHA512:
-  metadata.gz: 0a5f47b30dc2761fcd4fe64592f0bd8c75e97e894be120b995cd2046e7e6f912e417a48d32f6c76630ead5b9e7ebf8b8e8f8fba293dbe71d74c7c884d028b103
-  data.tar.gz: 32c775a711e06c294ac92012bc8b15f481598f369615130629ef51343ba81fd6529f33b99fdf8c0180e7ccd14e9f0394aab0b4309a40a2e06c35140a348c2567
+  metadata.gz: 94e653b2a765e962ba1f4c360308bab8a66bb32b8fe487def7ef9880c4b972f934f280fce5805a7f5dcdea60b2a591c0ff4ea87dff04ce6334d490506155aa5a
+  data.tar.gz: 13701b452c87df0a9fb4054857f37d5821b63bb0ee8e467556bc8bb1d5beeae0712ec2457462567a45a715bc8b5a60d68aad8811385d9353e61779bec68bf060

data/.github/CODEOWNERS

@@ -1 +1 @@
-*       @shopify/app-partner-dev-tools-education
+*       @shopify/platform-dev-tools-education

data/CHANGELOG

@@ -1,3 +1,7 @@
+== Version 6.0.0
+
+* Removed undocumented `protocol` and `port` options from `ShopifyAPI::Session`.
+
 == Version 5.2.4
 
 * Added `currency` parameter to `ShopifyAPI::Order#capture`. This parameter is required for apps that belong to the

data/README.md

@@ -88,20 +88,20 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
    We've added the create_permission_url method to make this easier, first instantiate your session object:
 
    ```ruby
-   session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com")
+   shopify_session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com")
    ```
 
    Then call:
 
    ```ruby
    scope = ["write_products"]
-   permission_url = session.create_permission_url(scope)
+   permission_url = shopify_session.create_permission_url(scope)
    ```
 
    or if you want a custom redirect_uri:
 
    ```ruby
-   permission_url = session.create_permission_url(scope, "https://my_redirect_uri.com")
+   permission_url = shopify_session.create_permission_url(scope, "https://my_redirect_uri.com")
    ```
 
 4. Once authorized, the shop redirects the owner to the return URL of your application with a parameter named 'code'. This is a temporary token that the app can exchange for a permanent access token.
@@ -131,37 +131,37 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
    the params, extract the temp code and then request your token:
 
    ```ruby
-   token = session.request_token(params)
+   token = shopify_session.request_token(params)
    ```
 
    This method will save the token to the session object and return it. All fields returned by Shopify, other than the access token itself, are stored in the session's `extra` attribute. For a list of all fields returned by Shopify, read [our OAuth documentation](https://help.shopify.com/api/guides/authentication/oauth#confirming-installation). If you requested an access token that is associated with a specific user, you can retreive information about this user from the `extra` hash:
 
    ```ruby
    # a list of all granted scopes
-   granted_scopes = session.extra['scope']
+   granted_scopes = shopify_session.extra['scope']
    # a hash containing the user information
-   user = session.extra['associated_user']
+   user = shopify_session.extra['associated_user']
    # the access scopes available to this user, which may be a subset of the access scopes granted to this app.
-   active_scopes = session.extra['associated_user_scope']
+   active_scopes = shopify_session.extra['associated_user_scope']
    # the time at which this token expires; this is automatically converted from 'expires_in' returned by Shopify
-   expires_at = session.extra['expires_at']
+   expires_at = shopify_session.extra['expires_at']
    ```
 
    For the security of your application, after retrieving an access token you must validate the following:
-   1) The list of scopes in `session.extra['scope']` is the same as you requested.
-   2) If you requested an online-mode access token, `session.extra['associated_user']` must be present.
+   1) The list of scopes in `shopify_session.extra['scope']` is the same as you requested.
+   2) If you requested an online-mode access token, `shopify_session.extra['associated_user']` must be present.
    Failing either of these tests means the end-user may have tampered with the url parameters during the OAuth authentication phase. You should avoid using this access token and revoke it immediately. If you use the [`omniauth-shopify-oauth2`](https://github.com/Shopify/omniauth-shopify-oauth2) gem these checks are done automatically for you.
 
    For future sessions simply pass in the `token` and `extra` hash (optional) when creating the session object:
 
    ```ruby
-   session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com", token, extra)
+   shopify_session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com", token, extra)
    ```
 
 5. The session must be activated before use:
 
    ```ruby
-   ShopifyAPI::Base.activate_session(session)
+   ShopifyAPI::Base.activate_session(shopify_session)
    ```
 
 6. Now you're ready to make authorized API requests to your shop! Data is returned as ActiveResource instances:

data/lib/shopify_api/session.rb

@@ -7,8 +7,7 @@ module ShopifyAPI
   end
 
   class Session
-    cattr_accessor :api_key, :secret, :protocol, :myshopify_domain, :port
-    self.protocol = 'https'
+    cattr_accessor :api_key, :secret, :myshopify_domain
     self.myshopify_domain = 'myshopify.com'
 
     attr_accessor :url, :token, :name, :extra
@@ -44,8 +43,7 @@ module ShopifyAPI
           shop = shop.slice(0, idx)
         end
         return nil if shop.empty?
-        shop = "#{shop}.#{myshopify_domain}"
-        port ? "#{shop}:#{port}" : shop
+        "#{shop}.#{myshopify_domain}"
       rescue URI::InvalidURIError
         nil
       end
@@ -105,7 +103,7 @@ module ShopifyAPI
     end
 
     def site
-      "#{protocol}://#{url}/admin"
+      "https://#{url}/admin"
     end
 
     def valid?
@@ -128,17 +126,18 @@ module ShopifyAPI
     end
 
     private
-      def parameterize(params)
-        URI.escape(params.collect{|k,v| "#{k}=#{v}"}.join('&'))
-      end
 
-      def access_token_request(code)
-        uri = URI.parse("#{protocol}://#{url}/admin/oauth/access_token")
-        https = Net::HTTP.new(uri.host, uri.port)
-        https.use_ssl = true
-        request = Net::HTTP::Post.new(uri.request_uri)
-        request.set_form_data({"client_id" => api_key, "client_secret" => secret, "code" => code})
-        https.request(request)
-      end
+    def parameterize(params)
+      URI.escape(params.collect { |k, v| "#{k}=#{v}" }.join('&'))
+    end
+
+    def access_token_request(code)
+      uri = URI.parse("https://#{url}/admin/oauth/access_token")
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.set_form_data('client_id' => api_key, 'client_secret' => secret, 'code' => code)
+      https.request(request)
+    end
   end
 end

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "5.2.4"
+  VERSION = "6.0.0"
 end

data/test/product_test.rb

@@ -47,4 +47,14 @@ class ProductTest < Test::Unit::TestCase
     variant.price = "0.50"
     variant.save
   end
+
+  def test_price_range
+    assert_equal('199.00', @product.price_range)
+  end
+
+  def test_price_range_when_has_different_price
+    @product.variants[0].price = '100.00'
+
+    assert_equal('100.00 - 199.00', @product.price_range)
+  end
 end

data/test/session_test.rb

@@ -56,10 +56,6 @@ class SessionTest < Test::Unit::TestCase
     assert_equal "My test secret", ShopifyAPI::Session.secret
   end
 
-  test "use 'https' protocol by default for all sessions" do
-    assert_equal 'https', ShopifyAPI::Session.protocol
-  end
-
   test "#temp reset ShopifyAPI::Base.site to original value" do
 
     ShopifyAPI::Session.setup(:api_key => "key", :secret => "secret")
@@ -115,28 +111,6 @@ class SessionTest < Test::Unit::TestCase
     assert_equal false, session.valid?
   end
 
-  test "#temp reset ShopifyAPI::Base.site to original value when using a non-standard port" do
-    ShopifyAPI::Session.setup(:api_key => "key", :secret => "secret")
-    session1 = ShopifyAPI::Session.new('fakeshop.myshopify.com:3000', 'token1')
-    ShopifyAPI::Base.activate_session(session1)
-  end
-
-  test "myshopify_domain supports non-standard ports" do
-    begin
-      ShopifyAPI::Session.setup(:api_key => "key", :secret => "secret", :myshopify_domain => 'localhost', port: '3000')
-      session = ShopifyAPI::Session.new('fakeshop.localhost:3000', 'token1')
-      ShopifyAPI::Base.activate_session(session)
-      assert_equal 'https://fakeshop.localhost:3000/admin', ShopifyAPI::Base.site.to_s
-
-      session = ShopifyAPI::Session.new('fakeshop', 'token1')
-      ShopifyAPI::Base.activate_session(session)
-      assert_equal 'https://fakeshop.localhost:3000/admin', ShopifyAPI::Base.site.to_s
-    ensure
-      ShopifyAPI::Session.myshopify_domain = "myshopify.com"
-      ShopifyAPI::Session.port = nil
-    end
-  end
-
   test "return site for session" do
     session = ShopifyAPI::Session.new("testshop.myshopify.com", "any-token")
     assert_equal "https://testshop.myshopify.com/admin", session.site

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 5.2.4
+  version: 6.0.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-09 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource