fake_shopify 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 269db357e22cce5ee0415963d2fbc05f8541c57f67e396c2c711c8c83247eef4
+  data.tar.gz: 935d5e2277e2f9cdcaeca8b33173cbccd944aae8a4f7de419a17b94afe131835
+SHA512:
+  metadata.gz: 8b7656ca249f6e477c62e506ccba83c38d4a3942716abdc73c5edaa84a036f4ec91590da61b567d1dace5743dffcf67d153c5a4708e8c74351bdb39574ad16c1
+  data.tar.gz: eec8a883b796c0f461c99ea4a3075fb7ad2d7b1fcb09c50da599b699ac9e3afeab0fe6c1b15b4074b4b158080e8e69098cb70891e133e366ec335823d25c2282

data/README.md

@@ -0,0 +1,72 @@
+# FakeShopify
+
+This gem provides a way to test a Shopify app without hitting Shopify's servers. It uses [Webmock](https://github.com/bblimke/webmock) to intercept all of the calls from Shopify's Ruby API library and returns JSON fixtures from Shopify's example documentation. The gem's design borrows heavily from thoughtbot's [FakeStripe](https://github.com/thoughtbot/fake_stripe) gem. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fake_shopify'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fake_shopify
+
+## Usage
+
+Require the library in your spec support:
+
+```ruby
+# spec/support/fake_stripe.rb
+require 'fake_shopify'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    FakeShopify.stub_shopify
+  end
+end
+```
+
+Then start a ShopiyAPI::Session with the following values:
+
+```ruby
+    session = ShopifyAPI::Session.new(
+      domain: 'domain',
+      token: 'foobar',
+      api_version: '2019-04',
+    )
+    ShopifyAPI::Base.activate_session(session)
+```
+
+For now, these exact values for `domain` and `api_version` are required.
+
+## Development Roadmap
+
+- Add more detailed usage instructions
+- Add fixtures for all other Shopify API versions
+- Allow users to set custom shop domain for testing
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fake_shopify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/fake_shopify/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FakeShopify project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fake_shopify/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+require "rubygems"
+require "bundler"
+require "rake"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks(name: "fake_shopify")
+
+desc "Default: run the specs and features."
+task default: %w(spec:requests)
+
+namespace :spec do
+  desc "Run request specs"
+  RSpec::Core::RakeTask.new("requests") do |t|
+    t.pattern = "spec/fake_shopify/requests/{*_spec.rb}"
+  end
+end

data/lib/fake_shopify.rb

@@ -0,0 +1,13 @@
+require "capybara"
+require "capybara/server"
+require "fake_shopify/configuration"
+require "fake_shopify/initializers/webmock"
+require "fake_shopify/stub_app"
+
+module FakeShopify
+  extend Configuration
+
+  def self.stub_shopify
+    stub_request(:any, /domain.myshopify.com/).to_rack(FakeShopify::StubApp)
+  end
+end

data/lib/fake_shopify/bootable.rb

@@ -0,0 +1,18 @@
+require "capybara"
+require "capybara/server"
+require "fake_shopify/utils"
+
+module Bootable
+  def boot(port = FakeShopify::Utils.find_available_port)
+    instance = new
+    Capybara::Server.new(instance, port: port).tap(&:boot)
+  end
+
+  def boot_once
+    @boot_once ||= boot(server_port)
+  end
+
+  def server_port
+    @server_port ||= FakeShopify::Utils.find_available_port
+  end
+end

data/lib/fake_shopify/configuration.rb

@@ -0,0 +1,11 @@
+module FakeShopify
+  module Configuration
+    attr_writer :fixture_path
+
+    DEFAULT_FIXTURE_PATH = File.join(File.dirname(__FILE__), "fixtures/")
+
+    def fixture_path
+      @fixture_path || DEFAULT_FIXTURE_PATH
+    end
+  end
+end

data/lib/fake_shopify/fixtures/2019-04/analytics/report/create.json

@@ -0,0 +1,9 @@
+{
+  "report": {
+    "id": 1016888664,
+    "name": "A new app report",
+    "shopify_ql": "SHOW total_sales BY order_id FROM sales SINCE -1m UNTIL today ORDER BY total_sales",
+    "updated_at": "2020-01-14T10:32:17-05:00",
+    "category": "custom_app_reports"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/analytics/report/destroy.json

@@ -0,0 +1 @@
+{}

data/lib/fake_shopify/fixtures/2019-04/analytics/report/index.json

@@ -0,0 +1,18 @@
+{
+  "reports": [
+    {
+      "id": 752357116,
+      "name": "Custom App Report 2",
+      "shopify_ql": "SHOW total_sales BY order_id FROM sales ORDER BY total_sales",
+      "updated_at": "2020-01-14T10:26:56-05:00",
+      "category": "custom_app_reports"
+    },
+    {
+      "id": 517154478,
+      "name": "Wholesale Sales Report",
+      "shopify_ql": "SHOW total_sales BY order_id FROM sales WHERE api_client_id == 123 SINCE -1m UNTIL today",
+      "updated_at": "2017-04-10T16:33:22-04:00",
+      "category": "custom_app_reports"
+    }
+  ]
+}

data/lib/fake_shopify/fixtures/2019-04/analytics/report/show.json

@@ -0,0 +1,9 @@
+{
+  "report": {
+    "id": 517154478,
+    "name": "Wholesale Sales Report",
+    "shopify_ql": "SHOW total_sales BY order_id FROM sales WHERE api_client_id == 123 SINCE -1m UNTIL today",
+    "updated_at": "2017-04-10T16:33:22-04:00",
+    "category": "custom_app_reports"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/analytics/report/update.json

@@ -0,0 +1,9 @@
+{
+  "report": {
+    "id": 517154478,
+    "name": "Changed Report Name",
+    "shopify_ql": "SHOW total_sales BY order_id FROM sales SINCE -12m UNTIL today ORDER BY total_sales",
+    "updated_at": "2020-01-14T10:32:18-05:00",
+    "category": "custom_app_reports"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/application_charge/activate.json

@@ -0,0 +1,15 @@
+{
+  "application_charge": {
+    "id": 675931192,
+    "name": "iPod Cleaning",
+    "api_client_id": 755357713,
+    "price": "5.00",
+    "status": "accepted",
+    "return_url": "http://google.com",
+    "test": null,
+    "created_at": "2020-01-14T10:41:30-05:00",
+    "updated_at": "2020-01-14T10:41:30-05:00",
+    "charge_type": null,
+    "decorated_return_url": "http://google.com?charge_id=675931192"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/application_charge/create.json

@@ -0,0 +1,16 @@
+{
+  "application_charge": {
+    "id": 1017262355,
+    "name": "Super Duper Expensive action",
+    "api_client_id": 755357713,
+    "price": "100.00",
+    "status": "pending",
+    "return_url": "http://super-duper.shopifyapps.com/",
+    "test": null,
+    "created_at": "2020-01-14T10:46:14-05:00",
+    "updated_at": "2020-01-14T10:46:14-05:00",
+    "charge_type": null,
+    "decorated_return_url": "http://super-duper.shopifyapps.com/?charge_id=1017262355",
+    "confirmation_url": "https://apple.myshopify.com/admin/charges/1017262355/confirm_application_charge?signature=BAh7BzoHaWRpBBMxojw6EmF1dG9fYWN0aXZhdGVG--5565cfdd49c43537113edcbfde3e4039b177aaae"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/application_charge/index.json

@@ -0,0 +1,43 @@
+{
+  "application_charges": [
+    {
+      "id": 1017262346,
+      "name": "Create me a logo",
+      "api_client_id": 755357713,
+      "price": "123.00",
+      "status": "accepted",
+      "return_url": "http://google.com",
+      "test": null,
+      "created_at": "2020-01-14T10:41:30-05:00",
+      "updated_at": "2020-01-14T10:41:30-05:00",
+      "charge_type": "brokered_service",
+      "decorated_return_url": "http://google.com?charge_id=1017262346"
+    },
+    {
+      "id": 556467234,
+      "name": "Green theme",
+      "api_client_id": 755357713,
+      "price": "120.00",
+      "status": "accepted",
+      "return_url": "http://google.com",
+      "test": null,
+      "created_at": "2020-01-14T10:41:30-05:00",
+      "updated_at": "2020-01-14T10:41:30-05:00",
+      "charge_type": "theme",
+      "decorated_return_url": "http://google.com?charge_id=556467234"
+    },
+    {
+      "id": 675931192,
+      "name": "iPod Cleaning",
+      "api_client_id": 755357713,
+      "price": "5.00",
+      "status": "accepted",
+      "return_url": "http://google.com",
+      "test": null,
+      "created_at": "2020-01-14T10:41:30-05:00",
+      "updated_at": "2020-01-14T10:41:30-05:00",
+      "charge_type": null,
+      "decorated_return_url": "http://google.com?charge_id=675931192"
+    }
+  ]
+}

data/lib/fake_shopify/fixtures/2019-04/billing/application_charge/show.json

@@ -0,0 +1,15 @@
+{
+  "application_charge": {
+    "id": 675931192,
+    "name": "iPod Cleaning",
+    "api_client_id": 755357713,
+    "price": "5.00",
+    "status": "accepted",
+    "return_url": "http://google.com",
+    "test": null,
+    "created_at": "2020-01-14T10:41:30-05:00",
+    "updated_at": "2020-01-14T10:41:30-05:00",
+    "charge_type": null,
+    "decorated_return_url": "http://google.com?charge_id=675931192"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/application_credit/create.json

@@ -0,0 +1,8 @@
+{
+  "application_credit": {
+    "id": 1031636125,
+    "amount": "5.00",
+    "description": "application credit for refund",
+    "test": null
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/application_credit/index.json

@@ -0,0 +1,10 @@
+{
+  "application_credits": [
+    {
+      "id": 445365009,
+      "amount": "5.00",
+      "description": "credit for application refund",
+      "test": null
+    }
+  ]
+}

data/lib/fake_shopify/fixtures/2019-04/billing/application_credit/show.json

@@ -0,0 +1,8 @@
+{
+  "application_credit": {
+    "id": 445365009,
+    "amount": "5.00",
+    "description": "credit for application refund",
+    "test": null
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/recurring_application_charges/activate.json

@@ -0,0 +1,19 @@
+{
+  "recurring_application_charge": {
+    "id": 455696195,
+    "name": "Super Mega Plan",
+    "api_client_id": 755357713,
+    "price": "15.00",
+    "status": "active",
+    "return_url": "http://yourapp.com",
+    "billing_on": "2020-02-13",
+    "created_at": "2020-01-14T10:26:56-05:00",
+    "updated_at": "2020-01-13T19:00:00-05:00",
+    "test": null,
+    "activated_on": "2020-01-14",
+    "cancelled_on": null,
+    "trial_days": 0,
+    "trial_ends_on": "2020-01-14",
+    "decorated_return_url": "http://yourapp.com?charge_id=455696195"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/recurring_application_charges/create.json

@@ -0,0 +1,20 @@
+{
+  "recurring_application_charge": {
+    "id": 1029266947,
+    "name": "Super Duper Plan",
+    "api_client_id": 755357713,
+    "price": "10.00",
+    "status": "pending",
+    "return_url": "http://super-duper.shopifyapps.com/",
+    "billing_on": null,
+    "created_at": "2020-01-14T10:31:40-05:00",
+    "updated_at": "2020-01-14T10:31:40-05:00",
+    "test": null,
+    "activated_on": null,
+    "cancelled_on": null,
+    "trial_days": 0,
+    "trial_ends_on": null,
+    "decorated_return_url": "http://super-duper.shopifyapps.com/?charge_id=1029266947",
+    "confirmation_url": "https://apple.myshopify.com/admin/charges/1029266947/confirm_recurring_application_charge?signature=BAh7BzoHaWRpBANeWT06EmF1dG9fYWN0aXZhdGVG--04f03cda5902ed6a0071e76df5dcfc95d4ee1a25"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/recurring_application_charges/customize.json

@@ -0,0 +1,24 @@
+{
+  "recurring_application_charge": {
+    "id": 455696195,
+    "name": "Super Mega Plan",
+    "api_client_id": 755357713,
+    "price": "15.00",
+    "status": "active",
+    "return_url": "http://yourapp.com",
+    "billing_on": "2018-09-04",
+    "created_at": "2020-01-14T10:26:56-05:00",
+    "updated_at": "2020-01-14T10:31:50-05:00",
+    "test": null,
+    "activated_on": "2020-01-14",
+    "cancelled_on": null,
+    "trial_days": 0,
+    "capped_amount": "100.00",
+    "trial_ends_on": "2020-01-14",
+    "balance_used": 0.0,
+    "balance_remaining": 100.0,
+    "risk_level": 0,
+    "decorated_return_url": "http://yourapp.com?charge_id=455696195",
+    "update_capped_amount_url": "https://apple.myshopify.com/admin/charges/455696195/confirm_update_capped_amount?signature=BAh7BzoHaWRpBENfKRs6EmF1dG9fYWN0aXZhdGVG--7062c2b92db057fe6e4297382d402bf6361d5c6a"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/recurring_application_charges/destroy.json

@@ -0,0 +1 @@
+{}

data/lib/fake_shopify/fixtures/2019-04/billing/recurring_application_charges/index.json

@@ -0,0 +1,21 @@
+{
+  "recurring_application_charges": [
+    {
+      "id": 455696195,
+      "name": "Super Mega Plan",
+      "api_client_id": 755357713,
+      "price": "15.00",
+      "status": "accepted",
+      "return_url": "http://yourapp.com",
+      "billing_on": "2020-01-14",
+      "created_at": "2020-01-14T10:26:56-05:00",
+      "updated_at": "2020-01-14T10:31:45-05:00",
+      "test": null,
+      "activated_on": null,
+      "cancelled_on": null,
+      "trial_days": 0,
+      "trial_ends_on": null,
+      "decorated_return_url": "http://yourapp.com?charge_id=455696195"
+    }
+  ]
+}

data/lib/fake_shopify/fixtures/2019-04/billing/recurring_application_charges/show.json

@@ -0,0 +1,20 @@
+{
+  "recurring_application_charge": {
+    "id": 455696195,
+    "name": "Super Mega Plan",
+    "api_client_id": 755357713,
+    "price": "15.00",
+    "status": "pending",
+    "return_url": "http://yourapp.com",
+    "billing_on": "2020-01-14",
+    "created_at": "2020-01-14T10:26:56-05:00",
+    "updated_at": "2020-01-14T10:26:56-05:00",
+    "test": null,
+    "activated_on": null,
+    "cancelled_on": null,
+    "trial_days": 0,
+    "trial_ends_on": null,
+    "decorated_return_url": "http://yourapp.com?charge_id=455696195",
+    "confirmation_url": "https://apple.myshopify.com/admin/charges/455696195/confirm_recurring_application_charge?signature=BAh7BzoHaWRpBENfKRs6EmF1dG9fYWN0aXZhdGVG--679000481979aae18d5e349f712aab6fb053a1ff"
+  }
+}

data/lib/fake_shopify/fixtures/2019-04/billing/usage_charge/create.json

@@ -0,0 +1,12 @@
+{
+  "usage_charge": {
+    "id": 1034618208,
+    "description": "Super Mega Plan 1000 emails",
+    "price": "1.00",
+    "created_at": "2020-01-14T10:43:06-05:00",
+    "billing_on": "2018-09-04",
+    "balance_used": 0.0,
+    "balance_remaining": 100.0,
+    "risk_level": 0
+  }
+}