shopify_theme 0.0.15 → 0.0.16

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09f5dc9eab1ad2d39124fc370b4e84047adf062a
+  data.tar.gz: 1119a4e02bff799bf80a7d91462b5c34bc68d1d6
+SHA512:
+  metadata.gz: 52d308c07b4d8c061c6971457eabb519fcaa87c205fefd27b2360d2fc3bcf5b4e1669ca981e897b3d493e4d149f2ac907896b6c37f98fb408d4387e02af88e69
+  data.tar.gz: 6fd1f422f49cc2ab4a129c1d5d6fc33eae3d6743a036ba02453e900bafd1e4f6de196cb3fcf9650d59d8f97094ebd540b5b83e43c2cbf2a447b7532d68518387

data/README.md

@@ -1,19 +1,36 @@
 # Edit your Shopify theme locally
 
-The Shopify theme gem is a command line tool that lets you make live changes to your published theme.
+The Shopify theme gem is a command line tool that lets you make live changes to themes on your Shopify store. If the command line is scary, check out the [Desktop Theme Editor app](http://apps.shopify.com/desktop-theme-editor).
 
 It will watch your local folders for any changes in your theme (including adding and removing files) and will update your .myshopify.com store to the latest changes. 
 
+![Shopify theme gem](https://dl.dropboxusercontent.com/u/669627/terminalreadme.png)
+
+You do not need to make changes to your default theme. You can leverage the theme preview feature of Shopify
+that allows you to view what an unpublished theme looks like on your Shopify store. This means you don't need to
+sign up for extra accounts and keep your shop up to date. You will however have a blue bar that shows up that you can
+remove via the web inspector in Chrome or Safari.
+
 # Requirements
 
-Ruby 1.9
+This gem works with OS X or Windows with Ruby 1.9. 
+
+First time installing Ruby on windows? Try [Rubyinstaller](http://http://rubyinstaller.org/). 
 
 # Installation
 
+To install the shopify_theme gem use 'gem install' (you might have use 'sudo gem install')
+
 ```
 gem install shopify_theme [optional_theme_id]
 ```
 
+to update to the latest version
+
+```
+gem update shopify_theme
+```
+
 # Usage
 
 Generate the config file. Go get a valid api_key and password for your store head to `https://[your store].myshopify.com/admin/apps/private` and generate a private application. Default it adds the main theme, if you want to edit one of your other themes, add the `theme_id`.
@@ -75,15 +92,22 @@ theme open
 
 # Common Problems
 
-### When trying to run `theme watch` on Windows the application crashes with a gross stack trace
-
-The gem doesn't install one of the dependencies you need in order to use this gem correctly on Windows. You
-can get around this by either executing `gem install wdm` or by creating a Gemfile in your theme project such
-as the following:
+## How do I edit a theme that isn't my shops main theme?
 
-```ruby
-source "http://rubygems.org" # I could not validate the rubygems SSL certificate on Windows
+This can be done by setting the `theme_id` field in `config.yml` which was created when you
+ran `theme configure`. Your file should look like the following:
 
-gem "wdm"
-gem "shopify_theme"
+```yaml
+---
+:api_key: 7a8da86d3dd730b67a357dedabaac5d6
+:password: 552338ce0d3aba7fc501dcf99bc57a81
+:store: little-plastics.myshopify.com
+:theme_id: 0987654321
 ```
+
+## Where can I find my Theme Id?
+
+Currently the best way to find the id of the theme you want to edit is to go to the theme in your
+shops admin and grab it from the url.
+
+![themes/THEME_ID/settings](doc/how_to_find_theme_id.png)

data/lib/shopify_theme.rb

@@ -5,14 +5,15 @@ module ShopifyTheme
   @@total_api_calls = 40
 
   NOOPParser = Proc.new {|data, format| {} }
-  TIMER_RESET = 5 * 60 + 5
-  PERMIT_LOWER_LIMIT = 10
+  TIMER_RESET = 10
+  PERMIT_LOWER_LIMIT = 3
 
   def self.test?
     ENV['test']
   end
 
   def self.manage_timer(response)
+    return unless response.headers['x-shopify-shop-api-call-limit']
     @@current_api_call_count, @@total_api_calls = response.headers['x-shopify-shop-api-call-limit'].split('/')
     @@current_timer = Time.now if @current_timer.nil?
   end
@@ -40,6 +41,10 @@ module ShopifyTheme
     end
   end
 
+  def self.api_usage
+    "[API Limit: #{@@current_api_call_count || "??"}/#{@@total_api_calls || "??"}]"
+  end
+
 
   def self.asset_list
     # HTTParty parser chokes on assest listing, have it noop

data/lib/shopify_theme/cli.rb

@@ -38,12 +38,17 @@ module ShopifyTheme
 
     desc "download FILE", "download the shops current theme assets"
     method_option :quiet, :type => :boolean, :default => false
+    method_option :exclude
     def download(*keys)
       assets = keys.empty? ? ShopifyTheme.asset_list : keys
 
+      if options['exclude']
+        assets = assets.delete_if { |asset| asset =~ Regexp.new(options['exclude']) }
+      end
+
       assets.each do |asset|
         download_asset(asset)
-        say("Downloaded: #{asset}", :green) unless options['quiet']
+        say("#{ShopifyTheme.api_usage} Downloaded: #{asset}", :green) unless options['quiet']
       end
       say("Done.", :green) unless options['quiet']
     end
@@ -157,6 +162,7 @@ module ShopifyTheme
     end
 
     def download_asset(key)
+      return unless valid?(key)
       notify_and_sleep("Approaching limit of API permits. Naptime until more permits become available!") if ShopifyTheme.needs_sleep?
       asset = ShopifyTheme.get_asset(key)
       if asset['value']
@@ -173,6 +179,7 @@ module ShopifyTheme
     end
 
     def send_asset(asset, quiet=false)
+      return unless valid?(asset)
       time = Time.now
       data = {:key => asset}
       content = File.read(asset)
@@ -183,19 +190,21 @@ module ShopifyTheme
         data.merge!(:value => content)
       end
 
-      if (response = ShopifyTheme.send_asset(data)).success?
+      response = ShopifyTheme.send_asset(data)
+      if response.success?
         say("[" + time.strftime(TIMEFORMAT) + "] Uploaded: #{asset}", :green) unless quiet
       else
-        say("[" + time.strftime(TIMEFORMAT) + "] Error: Could not upload #{asset}. #{errors_from_response(response)}", :red)
+        report_error(time, "Could not upload #{asset}", response)
       end
     end
 
     def delete_asset(key, quiet=false)
+      return unless valid?(key)
       time = Time.now
       if (response = ShopifyTheme.delete_asset(key)).success?
         say("[" + time.strftime(TIMEFORMAT) + "] Removed: #{key}", :green) unless quiet
       else
-        say("[" + time.strftime(TIMEFORMAT) + "] Error: Could not remove #{key}. #{errors_from_response(response)}", :red)
+        report_error(time, "Could not remove #{key}", response)
       end
     end
 
@@ -204,19 +213,33 @@ module ShopifyTheme
       ShopifyTheme.sleep
     end
 
+    def valid?(key)
+      return true if DEFAULT_WHITELIST.include?(key.split('/').first + "/")
+      say("'#{key}' is not in a valid file for theme uploads", :yellow)
+      say("Files need to be in one of the following subdirectories: #{DEFAULT_WHITELIST.join(' ')}", :yellow)
+      false
+    end
+
+    def report_error(time, message, response)
+      say("[#{time.strftime(TIMEFORMAT)}] Error: #{message}", :red)
+      say("Error Details: #{errors_from_response(response)}", :yellow)
+    end
+
     def errors_from_response(response)
-      return unless response.parsed_response
+      object = {status: response.headers['status'], request_id: response.headers['x-request-id']}
 
-      errors = response.parsed_response["errors"]
+      errors = response.parsed_response ? response.parsed_response["errors"] : response.body
 
-      case errors
+      object[:errors] = case errors
       when NilClass
         ''
       when String
-        errors
+        errors.strip
       else
         errors.values.join(", ")
       end
+      object.delete(:errors) if object[:errors].length <= 0
+      object
     end
   end
 end

data/lib/shopify_theme/version.rb

@@ -1,3 +1,3 @@
 module ShopifyTheme
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: shopify_theme
 version: !ruby/object:Gem::Version
-  version: 0.0.15
-  prerelease: 
+  version: 0.0.16
 platform: ruby
 authors:
 - John Duff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.14.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.14.4
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,65 +55,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: filewatcher
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 5.0.0
 description: Command line tool to help with developing Shopify themes. Provides simple
@@ -141,6 +126,7 @@ files:
 - README.md
 - Rakefile
 - bin/theme
+- doc/how_to_find_theme_id.png
 - lib/shopify_theme.rb
 - lib/shopify_theme/cli.rb
 - lib/shopify_theme/version.rb
@@ -150,33 +136,26 @@ files:
 homepage: https://github.com/Shopify/shopify_theme
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -577831141083631280
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -577831141083631280
 requirements: []
 rubyforge_project: shopify_theme
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Command line tool for developing themes
 test_files:
 - spec/spec_helper.rb