guard-shopify 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile.lock

@@ -1,25 +1,43 @@
 PATH
   remote: .
   specs:
-    guard-shopify (0.0.1)
-      shopify_api (~> 2.2.0)
+    guard-shopify (0.0.2)
+      guard (>= 0.10.0)
+      ptools (~> 1.2.1)
+      shopify_api (~> 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.3)
-      activesupport (= 3.1.3)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
       builder (~> 3.0.0)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
       i18n (~> 0.6)
-    activeresource (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-    activesupport (3.1.3)
       multi_json (~> 1.0)
     builder (3.0.0)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    guard (0.10.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
     i18n (0.6.0)
-    multi_json (1.0.4)
-    shopify_api (2.2.0)
+    multi_json (1.3.4)
+    ptools (1.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    shopify_api (3.0.0)
       activeresource (>= 3.0.0)
       thor (>= 0.14.4)
     thor (0.14.6)
@@ -28,4 +46,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  guard-rspec (~> 0.6.0)
   guard-shopify!
+  rspec (~> 2.8.0)

data/Guardfile

@@ -0,0 +1,36 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/README.md

@@ -9,9 +9,10 @@ Installation
 Please be sure to have [Guard](https://github.com/guard/guard) installed before you continue.
 
 Install the gem:
+
     $ gem install guard-shopify
 
-Add it to your Gemfile (inside development group):
+Add guard-shopify to your Gemfile (inside the development group):
 
 ``` ruby
 group :development do
@@ -19,22 +20,8 @@ group :development do
 end
 ```
 
-Add the guard definition to your Guardfile: 
-    $ guard init rspec
-
-When first run the gem will prompt you to enter your API key, password and store url. Follow [these instructions](http://http://wiki.shopify.com/Shopify_Textmate_Bundle) to get this information (you only need to do it once).
-
-Hello Hungry Academy
-====================
-
-I wrote this project for two reasons: I needed a code sample for my hungry academy application and I wanted to make my own client work significantly less painful.
-
-The best solution that existed before this gem was a Textmate bundle that allows you to upload modifications to Shopify with a keystroke. It sounds like a pretty good solution but Textmate and I broke up a long time ago and even having to save, upload, tab and refresh was a bit laborious for me. 
-
-It occurred to me that a guard could watch my filesystem for changes and upload modifications immediately on saving, allowing me to use vim instead of Textmate.
-
-This gem is not as full featured as I would like it to be, nor is it well tested, but it is my first independent open source contribution that may actually get used, and I'm quite pleased with this first release.
+Add the guard definition to your Guardfile:
 
-The immediate roadmap for guard-shopify includes test coverage, the ability to upload new files, delete existing files and optionally prompt before uploading changes to Shopify. 
+    $ guard init guard
 
-I'm only counting the hungry academy section of this file towards the 200 word limit you specified; if that's unacceptable please let me know and I will remove the installation instructions. 
+When first run the gem will prompt you to enter your API key, password and store url. Follow [these instructions](http://wiki.shopify.com/Shopify_Textmate_Bundle) to get this information (you only need to do it once).

data/guard-shopify.gemspec

@@ -4,7 +4,7 @@ require "guard/shopify/version"
 
 Gem::Specification.new do |s|
   s.name        = "guard-shopify"
-  s.version     = Guard::Shopify::VERSION
+  s.version     = Guard::ShopifyVersion::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jonan Scheffler"]
   s.email       = ["jonanscheffler+rubygems@gmail.com"]
@@ -20,6 +20,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'guard', '>= 0.10.0'
-  s.add_dependency 'shopify_api', '~> 2.2.0'
+  s.add_dependency 'shopify_api', '~> 3.0.0'
   s.add_dependency 'ptools', '~> 1.2.1'
+
+  s.add_development_dependency 'rspec', '~> 2.8.0'
+  s.add_development_dependency 'guard-rspec', '~> 0.6.0'
 end

data/lib/guard/shopify.rb

@@ -1,4 +1,5 @@
 require 'guard'
+require 'yaml'
 require 'guard/guard'
 require 'shopify_api'
 require 'ptools'
@@ -6,18 +7,44 @@ require 'ptools'
 module Guard
   class Shopify < Guard
     def start
-      set_config unless File.exists?("#{ENV['HOME']}/.guard_shopify")
+      set_config unless File.exists?(config_file_path)
       get_credentials_from_config
       authenticate_with_shopify
       get_main_theme_id
     end
 
+    def config_file_path
+      "#{ENV['HOME']}/.guard_shopify"
+    end
+
     def get_credentials_from_config
-      credentials = File.read("#{ENV['HOME']}/.guard_shopify").split("\n")
+      config = YAML.load_file(config_file_path)
+      # Check if config file is old format or new YAML-based one
+      unless config['secret']
+        config = upgrade_config_file
+      end
+      @url = config['url']
+      @api_key = config['api_key']
+      @password = config['password']
+    end
+
+    # Old line-based config file format
+    def upgrade_config_file
+      puts "Old config file found, upgrading..."
+      
+      credentials = File.read(config_file_path).split("\n")
+      config = {}
+      config['api_key'] = credentials[0]
+      config['password'] = credentials[1]
+      config['url'] = credentials[2]
 
-      @api_key = credentials[0]
-      @password = credentials[1]
-      @url = credentials[2]
+      config['secret'] = prompt "Please enter your API Shared Secret"
+
+      write_config config
+
+      puts 'Upgraded old config file to new format'
+
+      config
     end
 
     def authenticate_with_shopify
@@ -26,9 +53,7 @@ module Guard
 
     def get_main_theme_id
       themes = ShopifyAPI::Theme.find(:all)
-
       main_theme = themes.select {|t| t.role == 'main'}.first
-
       @theme_id = main_theme.id
     end
 
@@ -67,20 +92,31 @@ module Guard
 
     private
 
+    def prompt msg=nil
+      print "#{msg || 'Please type'}: "
+      gets.chomp
+    end
+
+    def write_config config
+      File.open(config_file_path, 'w') {|f| f.write(YAML.dump(config)) }
+    end
+
     def set_config
+      config = {}
       puts "This guard needs your API credentials to access your Shopify store."
-      puts "Please enter your API key:"
-      api_key = gets.chomp
-      puts "Please enter your password:"
-      password = gets.chomp
-      puts "Please enter your store's url (e.g. awesomesauce.myshopify.com):"
-      url = gets.chomp
-      url = url + '.myshopify.com' unless url.include?('myshopify.com')
       
-      config = [api_key, password, url].join("\n")
-
-      File.open("#{ENV['HOME']}/.guard_shopify", 'w') {|f| f.write(config) }
-      puts "Credentials saved to #{ENV['HOME']}/.guard_shopify"
+      config['api_key'] = prompt 'Please enter your API key'
+      
+      config['secret'] = prompt 'Please enter your API Shared Secret'
+      
+      config['url'] = prompt "Please enter your store's url (e.g. awesomesauce.myshopify.com)"
+      
+      unless config['url'].include?('myshopify.com')
+        config['url'] = "#{config['url']}.myshopify.com"
+      end
+      
+      write_config config
+      puts "Credentials saved to #{config_file_path}"
     end
   end
 end

data/lib/guard/shopify/version.rb

@@ -1,5 +1,5 @@
 module Guard
-  module Shopify
-    VERSION = "0.0.2"
+  module ShopifyVersion
+    VERSION = "0.0.3"
   end
 end

data/spec/fixtures/explanation.txt

@@ -0,0 +1 @@
+The accompanying photo was taken in a purikura machine in Tokyo during RubyKaigi 2011.

data/spec/guard/shopify_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Guard::Shopify do
+  before do
+    subject.stub!(:authenticate_with_shopify => true)
+  end
+
+  let(:subject) {Guard::Shopify.new}
+
+  context "run_on_change" do
+    let(:path) {'spec/fixtures/explanation.txt'}
+
+    before do
+      ShopifyAPI::Asset.stub!(:find) { true }
+    end
+
+    it "should call upload_binary_asset for binary files" do
+      path = 'spec/fixtures/purikura_avatar.jpg'
+
+      subject.should_receive :upload_binary_asset
+      subject.run_on_change([path])
+    end
+
+    it "should call upload_text_asset for text files" do
+      subject.should_receive :upload_text_asset
+      subject.run_on_change([path])
+    end
+
+    it "should notify the user when a file is changed" do
+      ShopifyAPI::Asset.stub!(:find) { false }
+      Guard::Notifier.should_receive(:notify).with /#{path}/
+      subject.run_on_change([path])
+    end
+  end
+
+  context "start" do
+    it "should prompt the user for their credentials if the config file doesn't exist" do
+      File.stub!(:exists?) { false }
+      subject.should_receive(:set_config).and_return true
+      subject.start
+    end
+  end
+
+  context "set_config" do
+    it "should write the credentials to a config file" do
+      File.should_receive(:open).with "#{ENV['HOME']}/.guard_shopify", "w"
+      subject.stub!(:gets).and_return('Foo')
+      subject.send(:set_config)
+    end
+
+    it "should accurately to the user the location of the config file" do
+      subject.should_receive(:puts).with "Credentials saved to #{ENV['HOME']}/.guard_shopify"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'guard'
+require 'guard/shopify'
+require 'shopify_api'
+require 'ptools'
+
+RSpec.configure do |config|
+
+  config.color_enabled = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+    ENV["GUARD_ENV"] = 'test'
+    @project_path    = Pathname.new(File.expand_path('../../', __FILE__))
+  end
+
+  config.after(:each) do
+    ENV["GUARD_ENV"] = nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-shopify
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-10 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70286699669020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,31 @@ dependencies:
         version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70286699669020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: shopify_api
-  requirement: &70286699668200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70286699668200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: ptools
-  requirement: &70286699667720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +53,44 @@ dependencies:
         version: 1.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70286699667720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: This gem allows guard to watch a Shopify template directory for changes
   and then upload them immediately to Shopify using their API.
 email:
@@ -52,9 +99,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -62,6 +111,10 @@ files:
 - lib/guard/shopify.rb
 - lib/guard/shopify/templates/Guardfile
 - lib/guard/shopify/version.rb
+- spec/fixtures/explanation.txt
+- spec/fixtures/purikura_avatar.jpg
+- spec/guard/shopify_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/1337807/guard-shopify
 licenses: []
 post_install_message: 
@@ -82,8 +135,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: guard-shopify
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Gem to upload Shopify template modifications.
-test_files: []
+test_files:
+- spec/fixtures/explanation.txt
+- spec/fixtures/purikura_avatar.jpg
+- spec/guard/shopify_spec.rb
+- spec/spec_helper.rb