shopify_theme 0.0.22 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2223be5c2de93ee62bfd2c4534e94407f10a4b59
-  data.tar.gz: d0d57181fa9d5e9aa9128c55a423e108e58cb70a
+  metadata.gz: 6971fe42d85d617b5d0a95de3c9e34279dac2199
+  data.tar.gz: d3ca43ec6f1b2ed28266e67a6036d748709a0f85
 SHA512:
-  metadata.gz: 909b624021715432d39077e4a15bbf03de67f996cb3994176b1ee49409d3f7b16ab17842d939804bc5f2d3c5cbd0220b42058e3b1c3c8234f6faa5bf67ea127e
-  data.tar.gz: ae1a012f19bc8a16bb7ca1d3ea142cb91bd13d7ff5d9c8071d7abd0f1e8ee7ef13dd7ddd21db1f642fdcb4dcbc9e688bfecff93533bf1ce305553fa119ef635f
+  metadata.gz: 994ba6ea158f91729a131200ebc778c72467234febfa8716e72f829156c75fd028e6d9c085ba80bc6fa0bd7e9a5d6c11a7778db69d1bd42c06e37134abfb87e2
+  data.tar.gz: 94ee9d1a1266d99e6b9a0f762e8bfe0e8cfa50bf09f2651a58d070e5de1c42e73020bfdadcfd3d45e1e51b8cbcb0ee54e2e83a9863dc8f1ad0f5a844c6e72592

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-.project
+.project
+.idea

data/.travis.yml

@@ -1,4 +1,5 @@
 langauge: ruby
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.0.23 (Unreleased)
+
+* Adds support for OAuth access token based authentication -- gavinballard
+
+# v0.0.22
+
+* Parsing of Timber release feed to always retrieve latest release
+* Minor documentation improvements
+
 # v0.0.21
 
 * Adds Locale support

data/README.md

@@ -10,7 +10,7 @@ The Shopify theme gem is a command line tool that allows you to manage and edit
 ## Requirements
 This gem works with OS X or Windows with Ruby 1.9.
 
-First time installing Ruby on Windows? Try [Rubyinstaller](http://http://rubyinstaller.org/).
+First time installing Ruby on Windows? Try [Rubyinstaller](http://rubyinstaller.org/).
 
 
 ## Configuration
@@ -24,9 +24,9 @@ Click on “Create a Private App” to generate the credentials for a new app. Y
 
 Navigate to the directory where you theme files live, or where you'd like them to be, and execute the following command:
 
-`theme configure api_key password store_name`
+`theme configure api_key password store_domain`
 
-**Important:** enter the `store_name` with no `http://`.
+**Important:** enter the `store_domain` with no `http://`.
 
 In your directory you should see a file named config.yml with your credentials. If you want, you may also edit the config.yml file directly and paste your API Key and Password in the appropriate area.
 
@@ -74,6 +74,17 @@ Specifies which files and directories should be responding to changes. If nothin
 
 Specifies which files should be explicitly ignored and not affected by any commands entered.
 
+### Alternative OAuth configuration (for advanced users)
+As of v0.0.23, you can use a Shopify application's OAuth access token to authenticate with a store and manipulate theme files.
+
+Once your application has obtained an access token through Shopify's regular OAuth authentication flow, run the following command to configure the gem:
+
+`theme configure_oauth access_token store_domain`
+
+The gem can then be used in exactly the same way as if you were authenticating via a Private App.
+
+Note that the access token your Application has obtained ***must*** be valid for the `write_themes` scope in order to use the theme gem in this way.
+
 
 ## Commands
 

data/bin/theme

@@ -20,6 +20,7 @@ fallback_load_path(File.join(File.dirname(__FILE__), '..', 'lib')) do
   require 'shopify_theme'
   require 'shopify_theme/cli'
   require 'shopify_theme/releases'
+  require 'shopify_theme/api_checker'
 end
 
 ShopifyTheme::Cli.start(ARGV)

data/lib/shopify_theme.rb

@@ -132,9 +132,13 @@ module ShopifyTheme
     shopify.get(path).code == 200
   end
 
+  def self.get_index
+    shopify.get(path)
+  end
+
   private
   def self.shopify
-    basic_auth config[:api_key], config[:password]
+    headers 'X-Shopify-Access-Token' => config[:password] || config[:access_token]
     base_uri "https://#{config[:store]}"
     ShopifyTheme
   end

data/lib/shopify_theme/api_checker.rb

@@ -0,0 +1,41 @@
+module ShopifyTheme
+  class APIChecker
+    class APIResult
+      OK = 200
+      UNAUTHORIZED = 401
+      SERVER_ERROR_CODES = (500..599)
+      
+      attr_reader :response
+      def initialize(http_response)
+        @response = http_response
+      end
+
+      def accessed_api?
+        response.code == OK
+      end
+
+      def cannot_access_api?
+        !accessed_api?
+      end
+
+      def invalid_config?
+        response.code == UNAUTHORIZED
+      end
+
+      def api_down?
+        SERVER_ERROR_CODES.include?(response.code)
+      end
+    end
+
+    def initialize(client)
+      @client = client
+    end
+
+    def test_connectivity
+      return APIResult.new(client.get_index)
+    end
+
+    private
+    attr_reader :client
+  end
+end

data/lib/shopify_theme/cli.rb

@@ -36,18 +36,36 @@ module ShopifyTheme
     end
 
     desc "check", "check configuration"
-    def check
-      if ShopifyTheme.check_config
-        say("Configuration [OK]", :green)
+    def check(exit_on_failure=false)
+      result = APIChecker.new(ShopifyTheme).test_connectivity
+
+      if result.api_down?
+        say("Cannot connect to Shopify. API appears to be down", :red)
+        say("Visit http://status.shopify.com for more details", :yello)
+      elsif result.invalid_config?
+        say("Cannot connect to Shopify. Configuration is invalid.", :red)
+        say("Verify that your API key, password and domain are correct.", :yellow)
+        say("Visit https://github.com/shopify/shopify_theme#configuration for more details", :yellow)
+        say("If your shop domain is correct, the following URL should take you to the Private Apps page for the shop:", :yellow)
+        say("  https://#{config[:store]}/admin/apps/private", :yellow)
       else
-        say("Configuration [FAIL]", :red)
+        say("Shopify API is accessible and configuration is valid", :green) unless exit_on_failure
       end
+
+      exit(1) if result.cannot_access_api? && exit_on_failure
     end
 
     desc "configure API_KEY PASSWORD STORE THEME_ID", "generate a config file for the store to connect to"
     def configure(api_key=nil, password=nil, store=nil, theme_id=nil)
       config = {:api_key => api_key, :password => password, :store => store, :theme_id => theme_id}
       create_file('config.yml', config.to_yaml)
+      check(true)
+    end
+
+    desc "configure_oauth ACCESS_TOKEN STORE THEME_ID", "generate a config file for the store to connect to using an OAuth access token"
+    def configure_oauth(access_token=nil, store=nil, theme_id=nil)
+      config = {:access_token => access_token, :store => store, :theme_id => theme_id}
+      create_file('config.yml', config.to_yaml)
     end
 
     desc "bootstrap API_KEY PASSWORD STORE THEME_NAME", "bootstrap with Timber to shop and configure local directory."
@@ -55,6 +73,7 @@ module ShopifyTheme
     method_option :version, :type => :string, :default => "latest"
     def bootstrap(api_key=nil, password=nil, store=nil, theme_name=nil)
       ShopifyTheme.config = {:api_key => api_key, :password => password, :store => store}
+      check(true)
 
       theme_name ||= 'Timber'
       say("Registering #{theme_name} theme on #{store}", :green)
@@ -78,6 +97,7 @@ module ShopifyTheme
     method_option :quiet, :type => :boolean, :default => false
     method_option :exclude
     def download(*keys)
+      check(true)
       assets = keys.empty? ? ShopifyTheme.asset_list : keys
 
       if options['exclude']
@@ -101,6 +121,7 @@ module ShopifyTheme
     desc "upload FILE", "upload all theme assets to shop"
     method_option :quiet, :type => :boolean, :default => false
     def upload(*keys)
+      check(true)
       assets = keys.empty? ? local_assets_list : keys
       assets.each do |asset|
         send_asset(asset, options['quiet'])
@@ -111,6 +132,7 @@ module ShopifyTheme
     desc "replace FILE", "completely replace shop theme assets with local theme assets"
     method_option :quiet, :type => :boolean, :default => false
     def replace(*keys)
+      check(true)
       say("Are you sure you want to completely replace your shop theme assets? This is not undoable.", :yellow)
       if ask("Continue? (Y/N): ") == "Y"
         # only delete files on remote that are not present locally
@@ -130,6 +152,7 @@ module ShopifyTheme
     desc "remove FILE", "remove theme asset"
     method_option :quiet, :type => :boolean, :default => false
     def remove(*keys)
+      check(true)
       keys.each do |key|
         delete_asset(key, options['quiet'])
       end
@@ -140,14 +163,14 @@ module ShopifyTheme
     method_option :quiet, :type => :boolean, :default => false
     method_option :keep_files, :type => :boolean, :default => false
     def watch
+      check(true)
       puts "Watching current folder: #{Dir.pwd}"
       watcher do |filename, event|
         filename = filename.gsub("#{Dir.pwd}/", '')
 
-        next unless local_assets_list.include?(filename)
-        action = if [:changed, :new].include?(event)
+        action = if [:changed, :new].include?(event) && local_assets_list.include?(filename)
           :send_asset
-        elsif event == :delete
+        elsif event == :delete && !options['keep_files']
           :delete_asset
         else
           raise NotImplementedError, "Unknown event -- #{event} -- #{filename}"

data/lib/shopify_theme/version.rb

@@ -1,3 +1,3 @@
 module ShopifyTheme
-  VERSION = "0.0.22"
+  VERSION = "0.0.23"
 end

data/spec/cassettes/api_check_api_down.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://something.myshopify.com/admin/assets.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Shopify-Access-Token:
+      - alakazam
+  response:
+    status:
+      code: 503
+      message: Unavailable
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 01 Sep 2015 18:47:36 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Sorting-Hat-Podid:
+      - '0'
+      X-Sorting-Hat-Shopid:
+      - '2538'
+      X-Sorting-Hat-Podid-Cached:
+      - '1'
+      X-Sorting-Hat-Shopid-Cached:
+      - '1'
+      Status:
+      - 401 Unauthorized
+      X-Frame-Options:
+      - DENY
+      X-Shopid:
+      - '2538'
+      X-Shardid:
+      - '0'
+      Www-Authenticate:
+      - Basic Realm="Shopify API Authentication"
+      X-Xss-Protection:
+      - 1; mode=block; report=/xss-report/6cb4f1eb-40ea-4f96-b36c-e7edc4cc6005?source%5Baction%5D=index&source%5Bcontroller%5D=admin%2Fassets&source%5Bsection%5D=admin
+      X-Request-Id:
+      - 6cb4f1eb-40ea-4f96-b36c-e7edc4cc6005
+    body:
+      encoding: UTF-8
+      string: '{"errors":"[API] Invalid API key or access token (unrecognized login
+        or wrong password)"}'
+    http_version: 
+  recorded_at: Tue, 01 Sep 2015 18:47:36 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/api_check_success.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://something.myshopify.com/admin/assets.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Shopify-Access-Token:
+      - alakazam
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 01 Sep 2015 18:47:35 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Sorting-Hat-Podid:
+      - '0'
+      X-Sorting-Hat-Shopid:
+      - '2538'
+      X-Sorting-Hat-Podid-Cached:
+      - '0'
+      X-Sorting-Hat-Shopid-Cached:
+      - '0'
+      Status:
+      - 401 Unauthorized
+      X-Frame-Options:
+      - DENY
+      X-Shopid:
+      - '2538'
+      X-Shardid:
+      - '0'
+      Www-Authenticate:
+      - Basic Realm="Shopify API Authentication"
+      X-Xss-Protection:
+      - 1; mode=block; report=/xss-report/f2203a5b-1bf3-4207-942b-81472f5d3073?source%5Baction%5D=index&source%5Bcontroller%5D=admin%2Fassets&source%5Bsection%5D=admin
+      X-Request-Id:
+      - f2203a5b-1bf3-4207-942b-81472f5d3073
+    body:
+      encoding: UTF-8
+      string: '{"errors":"[API] Invalid API key or access token (unrecognized login
+        or wrong password)"}'
+    http_version: 
+  recorded_at: Tue, 01 Sep 2015 18:47:36 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/api_check_unauthorized.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://something.myshopify.com/admin/assets.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Shopify-Access-Token:
+      - alakazam
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 01 Sep 2015 18:47:36 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Sorting-Hat-Podid:
+      - '0'
+      X-Sorting-Hat-Shopid:
+      - '2538'
+      X-Sorting-Hat-Podid-Cached:
+      - '1'
+      X-Sorting-Hat-Shopid-Cached:
+      - '1'
+      Status:
+      - 401 Unauthorized
+      X-Frame-Options:
+      - DENY
+      X-Shopid:
+      - '2538'
+      X-Shardid:
+      - '0'
+      Www-Authenticate:
+      - Basic Realm="Shopify API Authentication"
+      X-Xss-Protection:
+      - 1; mode=block; report=/xss-report/94fab138-9672-45ff-81b7-38f35ba81ed2?source%5Baction%5D=index&source%5Bcontroller%5D=admin%2Fassets&source%5Bsection%5D=admin
+      X-Request-Id:
+      - 94fab138-9672-45ff-81b7-38f35ba81ed2
+    body:
+      encoding: UTF-8
+      string: '{"errors":"[API] Invalid API key or access token (unrecognized login
+        or wrong password)"}'
+    http_version: 
+  recorded_at: Tue, 01 Sep 2015 18:47:36 GMT
+recorded_with: VCR 2.9.3

data/spec/unit/api_checker_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'shopify_theme'
+require 'shopify_theme/api_checker'
+
+module ShopifyTheme
+  describe "APIChecker" do
+    attr_reader :checker
+
+    before do
+      config = {
+        api_key: 'abracadabra',
+        password: 'alakazam',
+        store: 'something.myshopify.com'
+      }
+      ShopifyTheme.config = config
+      @checker = APIChecker.new(ShopifyTheme)
+    end
+
+    after do
+      ShopifyTheme.config = nil
+    end
+
+    it "should return an APIResponse that says if the API is accessible when it gets a 200 response" do
+      VCR.use_cassette("api_check_success") do
+        response = checker.test_connectivity
+        assert response.accessed_api?
+      end
+    end
+
+    it "should return an APIResponse that says the API is down if it gets a 500-series response" do
+      VCR.use_cassette("api_check_api_down") do
+        response = checker.test_connectivity
+        assert response.api_down?
+      end
+    end
+
+    it "should return an APIResponse that says the client is misconfigured if it gets a 401 response" do
+      VCR.use_cassette("api_check_unauthorized") do
+        response = checker.test_connectivity
+        assert response.invalid_config?
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_theme
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
 platform: ruby
 authors:
 - John Duff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -172,13 +172,18 @@ files:
 - doc/API-key-and-password.jpg
 - doc/how_to_find_theme_id.png
 - lib/shopify_theme.rb
+- lib/shopify_theme/api_checker.rb
 - lib/shopify_theme/cli.rb
 - lib/shopify_theme/releases.rb
 - lib/shopify_theme/version.rb
 - shipit.rubygems.yml
 - shopify_theme.gemspec
+- spec/cassettes/api_check_api_down.yml
+- spec/cassettes/api_check_success.yml
+- spec/cassettes/api_check_unauthorized.yml
 - spec/cassettes/timber_releases.yml
 - spec/spec_helper.rb
+- spec/unit/api_checker_spec.rb
 - spec/unit/cli_spec.rb
 - spec/unit/releases_spec.rb
 homepage: https://github.com/Shopify/shopify_theme
@@ -201,12 +206,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: shopify_theme
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Command line tool for developing themes
-test_files:
-- spec/cassettes/timber_releases.yml
-- spec/spec_helper.rb
-- spec/unit/cli_spec.rb
-- spec/unit/releases_spec.rb
+test_files: []