shopify-mock 0.0.3 → 0.1.0

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+.yardoc
+doc/*

data/lib/shopify-mock.rb

@@ -1,44 +1,98 @@
 require 'fakeweb'
 
-require 'shopify-mock/version'
+require 'shopify-mock/errors'
 require 'shopify-mock/urls'
 require 'shopify-mock/fixtures'
 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
-      def enabled
+      # 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::Response.register_all
+          ShopifyAPI::Mock.register_fixed_responses
         else
-          FakeWeb.clean_registry
+          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
-        ShopifyAPI::Mock.enabled = false
-        ShopifyAPI::Mock.enabled = true
+        raise ShopifyAPI::Mock::DisabledError, "cannot reset ShopifyAPI::Mock while it is disabled" \
+          unless ShopifyAPI::Mock.enabled?
+        self.class.register_fixed_responses
       end
       
-      def allow_internet
+      # 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
+          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
+          )
+          # register the resource fixture
+          registered_responses << ShopifyAPI::Mock::Response.new(
+            :get, "#{fixture.name.to_s}.#{fixture.ext.to_s}",
+            fixture.data
+          )
+        end
+        registered_responses
+      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/fixtures.rb

@@ -1,50 +1,115 @@
 module ShopifyAPI
   module Mock
-    class Fixtures
+    
+    # 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("./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("./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("./orders.xml")
+      #   data = fixture.data # => the contents of "./orders.xml"
+      #   fixture.data = "hello world"
+      #   data = fixture.data # => "hello world"
+      # @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("./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
-          Dir[File.join(ShopifyAPI::Mock::Fixtures.path, "**", "*.json")].map do |fixture|
-            File.basename(fixture, ".json").to_sym
+          Dir[File.join(ShopifyAPI::Mock::Fixture.path, "*")].map do |file_name|
+            fixture_name = File.basename(file_name)
+            @cache[fixture_name] ||= Fixture.new(file_name)
           end
         end
         
-        def read(name, ext = :json)
+        # 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}"
-          fixture = File.join(self.path, fixture_name)
-          raise "invalid fixture name" unless File.exists? fixture
-          @cache[fixture_name] = File.read(fixture) unless @cache.include? fixture_name
-          @cache[fixture_name]
-        end
-        
-        def use(name, content)
-          name = "#{name}.json"
-          if content == :default
-            @cache.delete name if @cache.include? name
-          else
-            @cache[name] = content
-          end
-          ShopifyAPI::Mock.reset
+          file_name = File.join(self.path, 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
-          ShopifyAPI::Mock.reset
-        end
-        
-        def reset
           @cache = {}
-          @path = nil
-          ShopifyAPI::Mock::Responses.register_all
         end
-        
       end
+      
     end
   end
 end

data/lib/shopify-mock/response.rb

@@ -1,25 +1,44 @@
 module ShopifyAPI
   module Mock
+    # used to manage the mocked responses
     class Response
+      # creates and registers a new mocked response
+      # @param [Symbol] method The method of the reponse. Can be one of [:put, :get, :post, :delete]
+      # @param [String] resource The path to the resource.
+      # @param [String] response The response to provide when that URL is called
+      # @return [FakeWeb] The FakeWeb object for the mocked response
+      # @example Registering a response to the path "/orders.count.xml" with the response "hello world"
+      #   ShopifyAPI::Mock::Response.register :get, "orders/count.xml", "hello world"
+      # @api public
+      def initialize(method, resource, response)
+        @@responses += FakeWeb.register_uri(
+          method, /#{SHOPIFY_MOCK_SHOP_BASE_URL}#{resource}/,
+          :body => response
+        )
+      end
+      
       class << self
-        def register(method, resource, response)
-          FakeWeb.register_uri(
-            method, /#{SHOPIFY_MOCK_SHOP_BASE_URL}#{resource}/,
-            :body => response
-          )
-        end
+        # store for all registered responses
+        @@responses = []
         
-        def register_all
-          count_fixture = ShopifyAPI::Mock::Fixtures.read(:count)
-          ShopifyAPI::Mock::Fixtures.all.each do |fixture|
-            ShopifyAPI::Mock::Response.register(:get, "#{fixture.to_s}/count.json", count_fixture)
-            ShopifyAPI::Mock::Response.register(
-              :get, "#{fixture.to_s}.json",
-              ShopifyAPI::Mock::Fixtures.read(fixture)
-            )
-          end
+        # finds all the registered responses
+        # @return [Array, FakeWeb] all the FakeWeb registered responses
+        # @example List all the registered responses
+        #   puts ShopifyAPI::Mock::Response.all
+        # @api public
+        def all
+          @@responses
         end
         
+        # clears all the currently registered responses
+        # @return [Array] the registered responses after clearing (should be empty)
+        # @example Clearing all registered responses
+        #   ShopifyAPI::Mock::Response.clear
+        # @api public
+        def clear
+          FakeWeb.clean_registry
+          @@responses = []
+        end
       end
     end
   end

data/lib/shopify-mock/urls.rb

@@ -1,7 +1,2 @@
-SHOPIFY_MOCK_SHOP = {
-  :domain   => "test.myshopify.com",
-  :api_key  => "apikey",
-  :secret   => "secret"
-}
-
-SHOPIFY_MOCK_SHOP_BASE_URL = "https://.*:.*@#{SHOPIFY_MOCK_SHOP[:domain]}/admin/"
+# base URL used for registering mock responses
+SHOPIFY_MOCK_SHOP_BASE_URL = "https://.*:.*@.*\.myshopify.com/admin/"

data/shopify-mock.gemspec

@@ -1,10 +1,9 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "shopify-mock/version"
 
 Gem::Specification.new do |s|
   s.name        = "shopify-mock"
-  s.version     = ShopifyMock::VERSION
+  s.version     = "0.1.0"
   s.authors     = ["Travis Haynes"]
   s.email       = ["travis.j.haynes@gmail.com"]
   s.homepage    = "https://github.com/travishaynes/shopify-mock"

data/spec/errors_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ShopifyAPI::Mock::DisabledError do
+  it { should be_kind_of StandardError }
+end

data/spec/fixtures_spec.rb

@@ -1,44 +1,58 @@
 require 'spec_helper'
 
-describe ShopifyAPI::Mock::Fixtures do
+describe ShopifyAPI::Mock::Fixture do
   
-  describe "#all" do
-    it "should return an array" do
-      ShopifyAPI::Mock::Fixtures.all.should be_kind_of Array
+  describe "#new" do
+    context "with invalid file name" do
+      it "should raise IOError" do
+        expect {ShopifyAPI::Mock::Fixture.new("invalid-file") }.should raise_error, IOError
+      end
+    end
+    
+    context "with valid file name" do
+      before do
+        @file_name = File.expand_path("../../lib/shopify-mock/fixtures/orders.json", __FILE__)
+        @fixture = ShopifyAPI::Mock::Fixture.new(@file_name)
+      end
+      specify { @fixture.should be_a ShopifyAPI::Mock::Fixture }
     end
   end
   
-  context "when given a valid fixture name" do
-    it "should return the contents of a fixture" do
-      @json = read_fixture :test
-      ShopifyAPI::Mock::Fixtures.read(:test).should eq @json
-    end
+  describe "#all" do
+    before { @all = ShopifyAPI::Mock::Fixture.all }
+    specify { @all.should be_kind_of Array }
+    specify { @all.length.should > 0 }
   end
   
-  context "when given an invalid fixture name" do
-    it "should raise an error" do
-      expect { ShopifyAPI::Mock::Fixtures.read(:brown_chicken_brown_cow) }.should raise_error
+  describe "#find" do
+    context "with a valid fixture name" do
+      before { @result = ShopifyAPI::Mock::Fixture.find :orders, :json }
+      specify { @result.should be_kind_of ShopifyAPI::Mock::Fixture }
+    end
+    context "with an invalid fixture name" do
+      before { @result = ShopifyAPI::Mock::Fixture.find :brown_chicken_brown_cow, :xml }
+      specify { @result.should be_nil }
     end
   end
   
-  context "custom fixtures" do
-    before { @json = '{ "count": 10 }' }
-    describe "#use" do
-      context "with custom fixture for content" do
-        it "should override default fixture" do
-          ShopifyAPI::Mock::Fixtures.read(:orders).should eq read_fixture :orders
-          ShopifyAPI::Mock::Fixtures.use :count, @json
-          ShopifyAPI::Mock::Fixtures.read(:count).should eq @json
-        end
-      end
-      context "with :default for content" do
-        it "should reset back to default fixture" do
-          ShopifyAPI::Mock::Fixtures.use :count, @json
-          ShopifyAPI::Mock::Fixtures.read(:count).should eq @json
-          ShopifyAPI::Mock::Fixtures.use :count, :default
-          ShopifyAPI::Mock::Fixtures.read(:orders).should eq read_fixture :orders
-        end
-      end
+  describe "#data" do
+    before { @fixture = ShopifyAPI::Mock::Fixture.find :orders, :json }
+    specify { @fixture.data.should_not be_empty }
+  end
+  
+  describe "#data=" do
+    before(:all) do
+      @fixture = ShopifyAPI::Mock::Fixture.find :orders, :json
+      @original_data = @fixture.data
+    end
+    it "should override the original content" do
+      @fixture.data.should eq @original_data
+      @fixture.data = 'new'
+      @fixture.data.should eq 'new'
+    end
+    it "should reset to original content when set to nil" do
+      @fixture.data = nil
+      @fixture.data.should eq @original_data
     end
   end
   

data/spec/mock_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ShopifyAPI::Mock do
+  
+  describe "#enabled=" do
+    context "given true" do
+      before { ShopifyAPI::Mock.enabled = true }
+      it "should register a response for each fixtures * 2 for the count fixtures" do        
+        ShopifyAPI::Mock::Response.all.count.should eq ShopifyAPI::Mock::Fixture.all.count * 2
+      end
+    end
+    
+    context "given false" do
+      before { ShopifyAPI::Mock.enabled = false }
+      it "should clear all registered responses" do
+        ShopifyAPI::Mock::Response.all.should be_empty
+      end
+    end
+  end
+
+  describe "#reset" do
+    context "while ShopifyAPI::Mock is disabled" do
+      it "should raise DisabledError" do
+        ShopifyAPI::Mock.enabled = false
+        expect { ShopifyAPI::Mock.reset }.to raise_error ShopifyAPI::Mock::DisabledError
+      end
+    end
+    
+    context "while ShopifyAPI::Mock is enabled" do
+    end
+  end
+  
+  describe "#allow_internet=" do
+    context "given true" do
+      before { ShopifyAPI::Mock.allow_internet = true }
+      it "should allow Internet access" do
+        FakeWeb.allow_net_connect?.should eq true
+      end
+    end
+    
+    context "given false" do
+      before { ShopifyAPI::Mock.allow_internet = false }
+      it "should not allow Internet access" do
+        FakeWeb.allow_net_connect?.should eq false
+      end
+    end
+  end
+  
+end

data/spec/response_spec.rb

@@ -2,30 +2,27 @@ require 'spec_helper'
 
 describe :response do
   
+  describe "#new" do
+    before { @fixture = ShopifyAPI::Mock::Fixture.find :orders }
+    it "should cache the new response" do
+      count = ShopifyAPI::Mock::Response.all.count
+      ShopifyAPI::Mock::Response.new(:get, "/orders.json", @fixture)
+      ShopifyAPI::Mock::Response.all.count.should eq count + 1
+    end
+  end
   
-  describe "all registered responses" do
-    ShopifyAPI::Mock::Fixtures.all.each do |fixture|
-      describe "##{fixture}" do
-        describe "GET /#{fixture}.json" do
-          before do
-            @json = read_fixture fixture
-            @response = get fixture
-          end
-          it "should return #{fixture.to_s}.json fixture" do
-            @response.body.should eq @json
-          end
-        end
-        
-        describe "GET /#{fixture}/count.json" do
-          before do
-            @json = read_fixture :count
-            @response = get [fixture, :count]
-          end
-          it "should return count json" do
-            @response.body.should eq @json
-          end
-        end
-      end
+  describe "#all" do
+    subject { ShopifyAPI::Mock::Fixture.all }
+    it { should be_kind_of Array }
+  end
+  
+  describe "#clear" do
+    it "should clear the responses" do
+      ShopifyAPI::Mock::Response.new(:get, "/orders.json", @fixture)
+      ShopifyAPI::Mock::Response.all.count.should > 0
+      ShopifyAPI::Mock::Response.clear
+      ShopifyAPI::Mock::Response.all.count.should eq 0
     end
   end
+  
 end

data/spec/support/http_support.rb

@@ -1,9 +1,9 @@
-def get(path = [], options = {}, user = SHOPIFY_MOCK_SHOP[:api_key], pass = SHOPIFY_MOCK_SHOP[:secret])
+def get(path = [], options = {}, user = "api_key", pass = "token")
   path = parse_path(path)
   options = parse_options(options)
   path = "#{path}?#{options}" unless options.nil?
   
-  http = Net::HTTP.new(SHOPIFY_MOCK_SHOP[:domain], 443)
+  http = Net::HTTP.new("test.myshopify.com", 443)
   http.use_ssl = true
   req = Net::HTTP::Get.new path
   req.basic_auth user, pass

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-mock
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-07 00:00:00.000000000Z
+date: 2011-09-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &16305320 !ruby/object:Gem::Requirement
+  requirement: &12454820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *16305320
+  version_requirements: *12454820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16299000 !ruby/object:Gem::Requirement
+  requirement: &12454320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *16299000
+  version_requirements: *12454320
 description: ! 'This gem is used for testing Shopify apps without having to actually
   connect to
 
@@ -57,6 +57,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/shopify-mock.rb
+- lib/shopify-mock/errors.rb
 - lib/shopify-mock/fixtures.rb
 - lib/shopify-mock/fixtures/articles.json
 - lib/shopify-mock/fixtures/assets.json
@@ -88,9 +89,10 @@ files:
 - lib/shopify-mock/fixtures/webhooks.json
 - lib/shopify-mock/response.rb
 - lib/shopify-mock/urls.rb
-- lib/shopify-mock/version.rb
 - shopify-mock.gemspec
+- spec/errors_spec.rb
 - spec/fixtures_spec.rb
+- spec/mock_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture_support.rb

data/lib/shopify-mock/version.rb

@@ -1,3 +0,0 @@
-module ShopifyMock
-  VERSION = "0.0.3"
-end