shopify_api 7.0.1 → 7.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f6c202f9c29838510495d77a8414965c76387dec57557eca68d1221150fea05
-  data.tar.gz: 62d74d1bd36f35fe1c53256dca2906564bb583e2d1bea0d80cb342a496c64b2d
+  metadata.gz: 536ae3dc24da93a37f8338cea6686c4018073f54b2a1dc4e8bbd4fdb25eb2c5f
+  data.tar.gz: 7ef36dd0517a77a70e5634d7fb359ef23f2f48622e44257514461400ffa367fd
 SHA512:
-  metadata.gz: 3ada5c8a355c109ac3ceef1dcb3aca833da26946ebfb3a4543356efc7bfbab6a1fe7c3de301b36785e5683f2c968fb210c441840881bc8265bcf507216ded6de
-  data.tar.gz: 6f0a5c32d25075e25eaed02bc6cfc78a1001ef2dadd8620978bd6ec5c7be5421bead11d8376216171f319a8315f431f16176f2f2f56997de8e4c8abf8642b5a5
+  metadata.gz: 1a76419a2c85136fd952596744c842c2a0bab63b7aae938b38c923537ea4560c741eb78a58af7d9fb042fcd700400766b430ce59fd47f5d06cb7b39a42c1794b
+  data.tar.gz: 65dc3afe191f8007b4b41d824b4e00bdf6256c01392399d0aac63363a412def433f376e8448d819504c88ba7014a8afe9ec9ccc5e4725093be1cf5797216f101

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+== Version 7.0.2
+
+* Add 2019-07 to known API versions.
+
 == Version 7.0.1
 
 * Support passing version string to `ShopifyAPI::Base.api_version` [#563](https://github.com/Shopify/shopify_api/pull/563)

data/README.md

@@ -38,7 +38,7 @@ ShopifyAPI::Session.temp(domain: domain, token: token, api_version: api_version)
 end
 ```
 
-The `api_version` attribute can take the string or symbol name of any known version and correctly coerce it to a `ShopifyAPI::ApiVersion`.  You can find the currently defined versions [here](https://github.com/Shopify/shopify_api/blob/master/lib/shopify_api/api_version.rb#L58), follow these [instructions](#adding-aditional-api-versions) to add additional version definitions if needed.
+The `api_version` attribute can take the string or symbol name of any known version and correctly coerce it to a `ShopifyAPI::ApiVersion`.  You can find the currently defined versions [here](https://github.com/Shopify/shopify_api/blob/master/lib/shopify_api/defined_versions.rb), follow these [instructions](#adding-additional-api-versions) to add additional version definitions if needed.
 
 For example if you want to use the `2019-04` version you would create a session like this:
 ```ruby
@@ -105,7 +105,7 @@ For more information and detailed documentation about the API visit https://deve
 
 #### Ruby version
 
-This gem requires Ruby 2.3.1 as of version 4.3. If you need to use an older Ruby version then update your `Gemfile` to lock onto an older release than 4.3.
+This gem requires Ruby 2.4 as of version 7.0.
 
 ### Installation
 
@@ -290,20 +290,20 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 
 ### Console
 
-This package also supports the ``shopify-cli`` executable to make it easy to open up an interactive console to use the API with a shop.
+This package also supports the ``shopify-api`` executable to make it easy to open up an interactive console to use the API with a shop.
 
-1. Install the ``shopify_cli`` gem.
+1. Install the ``shopify_api_console`` gem.
 
 ```bash
-gem install shopify_cli
+gem install shopify_api_console
 ```
 
 2. Obtain a private API key and password to use with your shop (step 2 in "Getting Started")
 
-3. Use the ``shopify-cli`` script to save the credentials for the shop to quickly log in.
+3. Use the ``shopify-api`` script to save the credentials for the shop to quickly log in.
 
    ```bash
-   shopify-cli add yourshopname
+   shopify-api add yourshopname
    ```
 
    Follow the prompts for the shop domain, API key and password.
@@ -311,13 +311,13 @@ gem install shopify_cli
 4. Start the console for the connection.
 
    ```bash
-   shopify-cli console
+   shopify-api console
    ```
 
 5. To see the full list of commands, type:
 
    ```bash
-   shopify-cli help
+   shopify-api help
    ```
 
 ## GraphQL
@@ -344,13 +344,13 @@ result = client.query(SHOP_NAME_QUERY)
 result.data.shop.name
 ```
 
-## Adding aditional API versions
+## Adding additional API versions
 We will release a gem update every time we release a new version of the API. Most of the time upgrading the gem will be all you need to do.
 
 If you want access to a newer version without upgrading you can define an api version.
 For example if you wanted to add an `ApiVersion` '2022-03', you would add the following to the initialization of your application:
 ```ruby
-ShopifyAPI::ApiVersion.define_version(ShopifyAPI::ApiVersion::Release.new('2022-03')
+ShopifyAPI::ApiVersion.define_version(ShopifyAPI::ApiVersion::Release.new('2022-03'))
 ```
 Once you have done that you can now set this version in a Sesssion like this:
 
@@ -374,6 +374,17 @@ bundle install
 bundle exec rake test
 ```
 
+or if you'd rather use docker just run:
+```bash
+docker run -it --name shopify_api -v "$PWD:/shopify_api" -w="/shopify_api" ruby:2.6 bundle install
+docker exec -it shopify_api bash
+```
+
+or you can even use our automated rake task for docker:
+```bash
+bundle exec rake docker
+```
+
 ## Additional Resources
 
 * [API Reference](https://help.shopify.com/api/reference)

data/Rakefile

@@ -37,3 +37,8 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task :docker do
+  cmd = "docker-compose up -d && docker exec -i -t shopify_api bash"
+  exec(cmd, err: File::NULL)
+end

data/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3.5'
+services:
+  api:
+    container_name: shopify_api
+    image: ruby:2.6
+    working_dir: /shopify_api
+    volumes:
+      - .:/shopify_api
+      - bundle:/usr/local/bundle
+    command: bash -c "bundle install && tail -f /dev/null"
+
+volumes:
+  bundle:

data/lib/shopify_api.rb

@@ -6,6 +6,7 @@ require 'digest/md5'
 require 'base64'
 require 'active_resource/detailed_log_subscriber'
 require 'shopify_api/limits'
+require 'shopify_api/defined_versions'
 require 'shopify_api/api_version'
 require 'active_resource/json_errors'
 require 'shopify_api/disable_prefix_check'

data/lib/shopify_api/api_version.rb

@@ -4,6 +4,8 @@ module ShopifyAPI
     class UnknownVersion < StandardError; end
     class InvalidVersion < StandardError; end
 
+    extend DefinedVersions
+
     include Comparable
 
     def self.coerce_to_version(version_or_name)
@@ -25,11 +27,6 @@ module ShopifyAPI
       @versions = {}
     end
 
-    def self.define_known_versions
-      define_version(Unstable.new)
-      define_version(Release.new('2019-04'))
-    end
-
     def self.latest_stable_version
       @versions.values.select(&:stable?).sort.last
     end

data/lib/shopify_api/defined_versions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  module DefinedVersions
+    def define_known_versions
+      define_version(ShopifyAPI::ApiVersion::Unstable.new)
+      define_version(ShopifyAPI::ApiVersion::Release.new('2019-04'))
+      define_version(ShopifyAPI::ApiVersion::Release.new('2019-07'))
+    end
+  end
+end

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "7.0.1"
+  VERSION = "7.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.0.2
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -201,6 +201,7 @@ files:
 - RELEASING
 - Rakefile
 - bin/shopify
+- docker-compose.yml
 - lib/active_resource/connection_ext.rb
 - lib/active_resource/detailed_log_subscriber.rb
 - lib/active_resource/json_errors.rb
@@ -208,6 +209,7 @@ files:
 - lib/shopify_api/api_version.rb
 - lib/shopify_api/connection.rb
 - lib/shopify_api/countable.rb
+- lib/shopify_api/defined_versions.rb
 - lib/shopify_api/disable_prefix_check.rb
 - lib/shopify_api/events.rb
 - lib/shopify_api/limits.rb