shopify_theme 0.0.10 → 0.0.11

data/.travis.yml

@@ -0,0 +1,4 @@
+langauge: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/README.md

@@ -16,7 +16,9 @@ Generate the config file. Go get a valid api_key and password for your store hea
 theme configure api_key password store_url
 ````
 
-Example of config.yml. Notice store has no http or https declaration.
+Example of config.yml. Notice store has no http or https declaration. You can
+use `:whitelist_files:` to specify files for upload. The `assets/`, `config/`,
+`layout/`, `snippets/` and `templates/` directories are included by default.
 
 ````
 ---
@@ -24,8 +26,9 @@ Example of config.yml. Notice store has no http or https declaration.
 :password: 552338ce0d3aba7fc501dcf99bc57a81
 :store: little-plastics.myshopify.com
 :theme_id:
-:ignore_files:
-- README
+:whitelist_files:
+- directoryToUpload/
+- importantFile.txt
 ````
 
 Download all the theme files

data/Rakefile

@@ -1,2 +1,14 @@
 require 'bundler'
+require 'rake/testtask'
 Bundler::GemHelper.install_tasks
+
+task :default => [:spec]
+
+Rake::TestTask.new 'spec' do |t|
+  ENV['test'] = 'true'
+  t.libs = ['lib', 'spec']
+  t.ruby_opts << '-rubygems'
+  t.verbose = true
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+

data/lib/shopify_theme.rb

@@ -3,11 +3,48 @@ module ShopifyTheme
   include HTTParty
 
   NOOPParser = Proc.new {|data, format| {} }
+  TIMER_RESET = 5 * 60 + 5
+  PERMIT_LOWER_LIMIT = 10
+
+  def self.test?
+    ENV['test']
+  end
+
+  def self.manage_timer(response)
+    @@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
+
+  def self.critical_permits?
+    @@total_api_calls.to_i - @@current_api_call_count.to_i < PERMIT_LOWER_LIMIT
+  end
+
+  def self.passed_api_refresh?
+    delta_seconds > TIMER_RESET
+  end
+
+  def self.delta_seconds
+    Time.now.to_i - @@current_timer.to_i
+  end
+
+  def self.needs_sleep?
+    critical_permits? && !passed_api_refresh?
+  end
+
+  def self.sleep
+    if needs_sleep?
+      Kernel.sleep(TIMER_RESET - delta_seconds)
+      @current_timer = nil
+    end
+  end
+
 
   def self.asset_list
     # HTTParty parser chokes on assest listing, have it noop
     # and then use a rel JSON parser.
     response = shopify.get(path, :parser => NOOPParser)
+    manage_timer(response)
+
     assets = JSON.parse(response.body)["assets"].collect {|a| a['key'] }
     # Remove any .css files if a .css.liquid file exists
     assets.reject{|a| assets.include?("#{a}.liquid") }
@@ -15,20 +52,35 @@ module ShopifyTheme
 
   def self.get_asset(asset)
     response = shopify.get(path, :query =>{:asset => {:key => asset}}, :parser => NOOPParser)
+    manage_timer(response)
+
     # HTTParty json parsing is broken?
-    JSON.parse(response.body)["asset"]
+    asset = response.code == 200 ? JSON.parse(response.body)["asset"] : {}
+    asset['response'] = response
+    asset
   end
 
   def self.send_asset(data)
-    shopify.put(path, :body =>{:asset => data})
+    response = shopify.put(path, :body =>{:asset => data})
+    manage_timer(response)
+    response
   end
 
   def self.delete_asset(asset)
-    shopify.delete(path, :body =>{:asset => {:key => asset}})
+    response = shopify.delete(path, :body =>{:asset => {:key => asset}})
+    manage_timer(response)
+    response
   end
 
   def self.config
-    @config ||= YAML.load(File.read('config.yml'))
+    @config ||= if File.exist? 'config.yml'
+      config = YAML.load(File.read('config.yml'))
+      puts ":ignore_files: is deprecated for a white list, use :whitelist_files: instead" if config[:ignore_files] && !test?
+      config
+    else
+      puts "config.yml does not exist!" unless test?
+      {}
+    end
   end
 
   def self.path
@@ -36,7 +88,11 @@ module ShopifyTheme
   end
 
   def self.ignore_files
-    @ignore_files ||= (config[:ignore_files] || []).compact.collect { |r| Regexp.new(r) }
+    @ignore_files ||= (config[:ignore_files] || []).compact.map { |r| Regexp.new(r) }
+  end
+
+  def self.whitelist_files
+    @whitelist_files ||= (config[:whitelist_files] || []).compact
   end
 
   def self.is_binary_data?(string)

data/lib/shopify_theme/cli.rb

@@ -14,6 +14,7 @@ module ShopifyTheme
 
     BINARY_EXTENSIONS = %w(png gif jpg jpeg eot svg ttf woff otf swf ico)
     IGNORE = %w(config.yml)
+    DEFAULT_WHITELIST = %w(layout/ assets/ config/ snippets/ templates/)
     TIMEFORMAT = "%H:%M:%S"
 
     tasks.keys.abbrev.each do |shortcut, command|
@@ -31,7 +32,7 @@ module ShopifyTheme
 
     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, :ignore_files => ["README"]}
+      config = {:api_key => api_key, :password => password, :store => store, :theme_id => theme_id}
       create_file('config.yml', config.to_yaml)
     end
 
@@ -120,14 +121,18 @@ module ShopifyTheme
     private
 
     def local_assets_list
-      Dir.glob(File.join("**", "*")).reject do |p|
-        File.directory?(p) || IGNORE.include?(p) || ShopifyTheme.ignore_files.any? do |i|
-          i =~ p
-        end
+      local_files.reject do |p|
+        @permitted_files ||= (DEFAULT_WHITELIST | ShopifyTheme.whitelist_files).map{|pattern| Regexp.new(pattern)}
+        @permitted_files.none? { |regex| regex =~ p }
       end
     end
 
+    def local_files
+      Dir.glob(File.join('**', '*'))
+    end
+
     def download_asset(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']
         # For CRLF line endings
@@ -169,6 +174,11 @@ module ShopifyTheme
       end
     end
 
+    def notify_and_sleep(message)
+      say(message, :red)
+      ShopifyTheme.sleep
+    end
+
     def errors_from_response(response)
       return unless response.parsed_response
 

data/lib/shopify_theme/version.rb

@@ -1,3 +1,3 @@
 module ShopifyTheme
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/shopify_theme.gemspec

@@ -13,13 +13,15 @@ Gem::Specification.new do |s|
   s.description = %q{Command line tool to help with developing Shopify themes. Provides simple commands to download, upload and delete files from a theme. Also includes the watch command to watch a directory and upload files as they change.}
 
   s.rubyforge_project = "shopify_theme"
-  s.add_development_dependency 'rake'
   s.add_dependency("thor", [">= 0.14.4"])
   s.add_dependency("httparty", "~> 0.11")
-  s.add_dependency("json")
+  s.add_dependency("json", "~> 1.5.4")
   s.add_dependency("listen", "~>1.0")
   s.add_dependency("launchy")
 
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest', '>= 5.0.0'
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'minitest/autorun'

data/spec/unit/cli_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'shopify_theme'
+require 'shopify_theme/cli'
+
+module ShopifyTheme
+  describe "Cli" do
+
+    class CliDouble < Cli
+      attr_writer :local_files
+
+      desc "", ""
+      def local_files
+        @local_files
+      end
+    end
+
+    before do
+      @cli = CliDouble.new
+    end
+
+    it "should remove assets that are not a part of the white list" do
+      @cli.local_files = ['assets/image.png', 'config.yml', 'layout/theme.liquid']
+      assert_equal 2, @cli.send(:local_assets_list).length
+      assert_equal false, @cli.send(:local_assets_list).include?('config.yml')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_theme
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2013-11-04 00:00:00.000000000 Z
 dependencies:
-- !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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -64,17 +48,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +91,38 @@ dependencies:
     - - ! '>='
       - !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
   commands to download, upload and delete files from a theme. Also includes the watch
   command to watch a directory and upload files as they change.
@@ -118,6 +134,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -127,6 +144,8 @@ files:
 - lib/shopify_theme/cli.rb
 - lib/shopify_theme/version.rb
 - shopify_theme.gemspec
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb
 homepage: https://github.com/Shopify/shopify_theme
 licenses: []
 post_install_message: 
@@ -139,16 +158,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1305888406830472996
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1305888406830472996
 requirements: []
 rubyforge_project: shopify_theme
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Command line tool for developing themes
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb