shopify-mock-new 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e27b311515d3c1461b6e8f8328816cf9aeb0b404
+  data.tar.gz: a3db30ddbe4063e8206bfced54c4974058cb4d79
+SHA512:
+  metadata.gz: 0e0b8e163fb5d51c807d9c63434e22739ebdec66fd962af3d53261eadb53bb0cdc7fd50022641d3aace96baa4771eb2c2f2fd12a1637e57f9bec8e50aeac70c6
+  data.tar.gz: 795c0936be8e15905746772f19024c9ecfb36518409e9f26ebcbf20873f6f0759f1b1d94a2f827ff74dac3d8ae99e414cebfd3562d78dbf80800df10bda3b237

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc
+doc/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.3
+  * Merged hjblok/shopify-mock oauth2 branch which makes the SHOPIFY_MOCK_SHOP_BASE_URL
+    have optional basic auth params. Without this, testing against current shopify stores
+    will fail because it will expect you to be hitting a url with basic auth in it.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in shopify-mock.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,121 @@
+= shopify-mock
+
+This gem is used for testing Shopify apps without having to actually connect to
+Shopify to develop the application.
+
+You can use this gem explicitly for testing, or you can also use it in your
+development environment to speed things up when fiddling around in the web
+browser, or in the console.
+
+== Installation
+
+Add the gem to your Gemfile in the appropriate group:
+
+    gem 'shopify-mock', :group => [:development, :test]
+
+== Enabling / Disabling
+
+For non Rails apps, shopify-mock is disabled by default, and real-world Internet
+access is allowed. In a Rails app, shopify-mock is disabled except for in the :test
+environment.
+
+To enable / disable shopify-mock manually, set ShopifyAPI::Mock.enabled to true or false:
+
+    ShopifyAPI::Mock.enabled = true         # or false to disable
+    ShopifyAPI::Mock.enabled?               # => to get the current state
+
+And to completely disable access to the Internet altogether, or re-enable it:
+
+    ShopifyAPI::Mock.allow_internet = false # or true to re-enable
+    ShopifyAPI::Mock.allow_internet?        # => to get the current state
+
+== Example
+
+After installing the gem in your Shopify app, load the rails console, and try
+this quick example:
+
+    rails c test
+    order = ShopifyAPI::Session.temp("test", "randomtoken") { ShopifyAPI::Order.first }
+
+You'll notice that the order was not downloaded from Shopify, but based off of
+a shopify-mock fixture found in lib/shopify-mock/fixtures/orders.json
+
+== Responses
+
+You have access to all the registered mock responses through ShopifyAPI::Mock::Response
+
+    ShopifyAPI::Mock::Response.all   # => array of all registered responses
+    ShopifyAPI::Mock::Response.clear # => clears all the currently registered responses
+
+You also have access to each Shopify object asset by it's `id` based on the ids in the fixtures.  If you are using the fixtures include in the gem, you can do
+    
+    product = ShopifyAPI::Product.find(632910392)
+
+and you'll get back the fixture product called `Ipod Nano 8GB`
+
+And you can register your own response:
+    
+    ShopifyAPI::Mock::Response.new(:get, "orders/1.xml", "response content")
+
+== Fixtures
+
+You have access to the shopify-mock fixtures through ShopifyAPI::Mock::Fixture
+
+    ShopifyAPI::Mock::Fixture.all                   # => an array of all the fixtures
+    ShopifyAPI::Mock::Fixture.find(:orders, :json)  # => returns the orders.json fixture
+    ShopifyAPI::Mock::Fixture.path                  # => the path to the fixture files
+    
+    # to use your own fixture path:
+    ShopifyAPI::Mock::Fixture.path = File.join(Rails.root, 'spec', 'fixtures')
+    ShopifyAPI::Mock.reset # => to reload the fixtures
+    
+A Fixture object has these methods:
+    
+    fixture = ShopifyAPI::Mock::Fixture.all.first
+    
+    fixture.name  # => the name of the fixture, such as :orders
+    fixture.ext   # => the extension of the fixture, such as :json, or :xml
+    fixture.data  # => the file contents
+    
+    # to override the fixture's contents:
+    fixture.data = "new contents" # => use "new contents" for this fixture
+    fixture.data = nil            # => resets back to default contents
+    
+== Contributing to shopify-mock
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Resources
+
+* All of the default fixtures were copied directly from the {Shopify API}[http://api.shopify.com]
+
+
+== License
+
+MIT License
+
+Copyright (c) 2011 Travis Haynes.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+task :default => [:spec]
+
+desc "runs all specs"
+task :spec do
+  files = Dir[File.expand_path("../spec/**/*_spec.rb", __FILE__)].join(" ")
+  puts files
+  exec "bundle exec rspec #{files}"
+end

data/lib/shopify-mock.rb

@@ -0,0 +1,136 @@
+require 'fakeweb'
+require 'xml'
+require 'json'
+
+require 'shopify-mock/errors'
+require 'shopify-mock/urls'
+require 'shopify-mock/fixture'
+require 'shopify-mock/response'
+
+# Mock is an extension for the ShopifyAPI
+module ShopifyAPI
+  # the main module for managing the Shopify mocks
+  module Mock
+    class << self
+      # get the enabled state of ShopifyAPI::Mock
+      # @return [Boolean] true if enabled
+      # @example Check if ShopifyAPI::Mock is enabled
+      #   ShopifyAPI::Mock.enabled # => true or false
+      # @api public
+      def enabled?
+        @enabled || false
+      end
+      
+      # enable or disable ShopifyAPI::Mock
+      # @param [Boolean] value true to enable ShopifyAPI::Mock, false to disable
+      # @return [Boolean] true if enabled
+      # @example Enabling ShopifyAPI::Mock
+      #   ShopifyAPI::Mock.enabled = true
+      # @api public
+      def enabled=(value=false)
+        return @enabled if value == @enabled
+        if value
+          #load File.expand_path("../shopify-mock/responses.rb", __FILE__)
+          ShopifyAPI::Mock.register_fixed_responses
+        else
+          ShopifyAPI::Mock::Response.clear
+        end
+        @enabled = value
+      end
+      
+      # resets the ShopifyAPI::Mocks back to their original state
+      # @return [Boolean] true when successful
+      # @example Reset the mocks
+      #   ShopifyAPI::Mock.reset
+      # @raise [ShopifyAPI::Mock::DisabledError] Raised when trying to reset the mocks when they are disabled
+      # @api public
+      def reset
+        raise ShopifyAPI::Mock::DisabledError, "cannot reset ShopifyAPI::Mock while it is disabled" \
+          unless ShopifyAPI::Mock.enabled?
+        ShopifyAPI::Mock.enabled = false
+        ShopifyAPI::Mock.enabled = true
+      end
+      
+      # gets the state of access to the real Internet
+      # @return [Boolean] false if all access to the Internet has been disabled
+      # @example Check if access has been disabled
+      #   can_access_internet = Shopify::Mock.allow_internet
+      # @api public
+      def allow_internet?
+        @allow_internet || true
+      end
+      
+      # enables or disables access to the real Internet
+      # @return [Boolean] status of real Internet access
+      # @example Turn off access to the Internet altogether
+      #   Shopify::Mock.allow_internet = false
+      # @api public
+      def allow_internet=(state = true)
+        return @allow_internet if @allow_internet == state
+        @allow_internet = state
+        FakeWeb.allow_net_connect = @allow_internet
+      end
+      
+      # registers all the fixed responses
+      # @return [Array] the responses that were registered
+      # @api private
+      def register_fixed_responses
+        ShopifyAPI::Mock::Response.clear
+        
+        registered_responses = []
+        ShopifyAPI::Mock::Fixture.all.each do |fixture|
+          # register the count fixture for this resource, if it exists
+          count_fixture = ShopifyAPI::Mock::Fixture.find(:count, fixture.ext.to_sym)
+          registered_responses << ShopifyAPI::Mock::Response.new(
+            :get, "#{fixture.name.to_s}/count.#{fixture.ext}",
+            count_fixture.data
+          ) unless count_fixture.nil?
+          # register the resource fixture
+          registered_responses << ShopifyAPI::Mock::Response.new(
+            :get, "#{fixture.name.to_s}.#{fixture.ext.to_s}",
+            fixture.data
+          )
+          # register the individual get by id
+          # /products/:id.:format
+          #TODO : add xml responses as well
+          fixture_data = parse_fixture_data(fixture)
+          if fixture.ext == :json
+            objects = fixture_data[fixture.name.to_s]
+            if objects && objects.is_a?(Array)
+              objects.each do |obj|
+                if obj.has_key? 'id'
+                  result = { "#{fixture.name.to_s.singularize}" => obj }
+                  registered_responses << ShopifyAPI::Mock::Response.new(:get, "#{fixture.name.to_s}/#{obj['id']}.#{fixture.ext.to_s}", result.to_json)
+                end
+              end
+            end
+          elsif fixture.ext == :xml
+            objects = fixture_data.find("//#{fixture.name.to_s}/#{fixture.name.to_s.singularize}")
+            if objects
+              objects.each do |obj|
+                id_node = obj.find_first('id')
+                if id_node && id_node.content
+                  _id = id_node.content
+                  registered_responses << ShopifyAPI::Mock::Response.new(:get, "#{fixture.name.to_s}/#{_id}.#{fixture.ext.to_s}", obj.to_s)
+                end
+              end
+            end
+          end
+        end
+      end
+      
+      private
+      def parse_fixture_data(fixture)
+        case fixture.ext
+        when :xml
+          XML::Document.string(fixture.data)
+        when :json
+          JSON.parse(fixture.data)
+        end
+      end
+    end
+  end
+end
+
+# enable mocking in Rails test environments by default
+ShopifyAPI::Mock.enabled = defined?(Rails) && Rails.env.test?

data/lib/shopify-mock/errors.rb

@@ -0,0 +1,6 @@
+module ShopifyAPI
+  module Mock
+    # raised on the event that access is attempted while Shopify::Mock is disabled
+    class DisabledError < StandardError; end
+  end
+end

data/lib/shopify-mock/fixture.rb

@@ -0,0 +1,124 @@
+module ShopifyAPI
+  module Mock
+    
+    # provides easy access to fixtures
+    class Fixture
+      @@path = nil
+      @@cache = {}
+      
+      # creates a new instance of ShopifyAPI::Mock::Fixture
+      # @param [String] file_name The location of the file to load into the fixture
+      # @raise [IOError] Raised when file_name is invalid
+      # @api private
+      def initialize(file_name)
+        raise IOError, "File not found: #{file_name}" unless File.exists? file_name
+        @file_name = file_name
+      end
+      
+      # gets the content of the fixture
+      # @return [String] the contents of the file, or @data if it was overwritten
+      # @example Create a fixture and read its contents
+      #   fixture = ShopifyAPI::Fixture.new "./orders.xml"
+      #   data = fixture.data # => the contents of "./orders.xml"
+      # @api public
+      def data
+        @data || File.read(@file_name)
+      end
+      
+      # gets the name of the fixture
+      # @return [Symbol] the the file name without the extension
+      # @example Load a fixture and get its name
+      #   fixture = ShopifyAPI::Fixture.new "./orders.xml"
+      #   name = fixture.name # => :orders
+      # @api public
+      def name
+        File.basename(@file_name, ".#{self.ext.to_s}").to_sym
+      end
+      
+      # overrides the contents of the fixture
+      # @param [String] value The new value to use, or set to nil to reset to default
+      # @return The new contents of the fixture
+      # @example Override a the contents of a fixture
+      #   fixture = ShopifyAPI::Fixture.new "./orders.xml"
+      #   data = fixture.data # => the contents of "./orders.xml"
+      #   fixture.data = "hello world"
+      #   data = fixture.data # => "hello world"
+      # @example Set contents of a fixture back to their default
+      #   fixture.data = nil
+      # @api public
+      def data=(value)
+        @data = value
+        data
+      end
+      
+      # gets the extension of the fixture
+      # @return [Symbol] The extension
+      # @example Create a new fixture and get its extension
+      #   fixture = ShopifyAPI::Fixture.new "./orders.xml"
+      #   ext = fixture.ext # => :xml
+      # @api public
+      def ext
+        File.extname(@file_name).gsub(".","").to_sym
+      end
+      
+      class << self
+        # finds all the fixtures
+        # @return [Array, Fixture] an array of all the Fixtures
+        # @example Find all the fixtures
+        #   ShopifyAPI::Mock::Fixture.all
+        # @api public
+        def all
+          # get a list of all the fixture files
+          files = []
+          Dir[File.join(ShopifyAPI::Mock::Fixture.path, "**", "*")].each do |f|
+            files << f unless File.directory? f
+          end
+          
+          # map files to fixtures
+          files.map do |file_name|
+            fixture_name = File.basename(file_name)
+            @@cache[fixture_name] ||= Fixture.new(file_name)
+          end
+        end
+        
+        # finds a fixture by name
+        # @param [Symbol] name The name of the fixture
+        # @param [Symbol] ext The extension of the symbol - defaults to :json
+        # @return [ShopifyAPI::Mock::Fixture] The fixture or nil if not found
+        # @example Find the orders json fixture
+        #   fixture = ShopifyAPI::Mock::Fixture.find :orders
+        # @example Find the orders xml fixture
+        #   fixture = ShopifyAPI::Mock::Fixture.find :orders, :xml
+        # @api public
+        def find(name, ext = :json)
+          fixture_name = "#{name.to_s}.#{ext.to_s}"
+          file_name = File.join(self.path, ext.to_s, fixture_name)
+          return nil unless File.exists? file_name
+          @@cache[fixture_name] ||= Fixture.new(file_name)
+        end
+        
+        # gets the current path to the fixtures
+        # @return [String] The fixtures path
+        # @example Get the fixtures path
+        #   fixture_path = ShopifyAPI::Mock::Fixture.path
+        # @api public
+        def path
+          @@path ||= File.expand_path("../fixtures/", __FILE__)
+        end
+        
+        # sets the current fixtures path
+        # @param [String] value The new fixtures path
+        # @return [String] The new fixtures path
+        # @example Override the default fixtures path
+        #   ShopifyAPI::Mock::Fixture.path = File.join(Rails.root, "spec", "fixtures", "shopify")
+        # @api public
+        def path=(value)
+          return @@path if @@path == value
+          @@path = value
+          @@cache = {}
+        end
+      end
+      
+    end
+  end
+end

data/lib/shopify-mock/fixtures/json/application_charges.json

@@ -0,0 +1,13 @@
+{
+  "application_charge": {
+    "price": "100.00",
+    "name": "Super Duper Expensive action",
+    "created_at": "2011-09-06T11:46:15-04:00",
+    "return_url": "http://super-duper.shopifyapps.com?charge_id=1007331646",
+    "updated_at": "2011-09-06T11:46:15-04:00",
+    "confirmation_url": "http://apple.myshopify.com/admin/subscriptions/confirm_application_charge/1007331646?signature=BAhpBD6pCjw%3D--ce8f74151dcf7c56ebbf2a15f7a2694533b46fd4",
+    "id": 1007331646,
+    "test": null,
+    "status": "pending"
+  }
+}