shopify_api_extensions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 669382f32ae875f7419395682f6b11a932113772
+  data.tar.gz: 7f495c319a658221d52fdf193157f514870ca9d2
+SHA512:
+  metadata.gz: ae8de816b00c9522492261e3bbd55d8a472e2413157bccbfa9901efd5463f2d4289745889cf1af2e359352eed0021399f7b7b64f96776740714cd69f8f79e899
+  data.tar.gz: 9914fd6231fcee1abdc6dc135e677f815461a2b09e75375cf5e406ea8fd4775d380fe70525493ce49f169e8d852cd05496e97791fbb35c4a2a8d8b96dd196d3e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shopify_api_extensions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Bianco
+
+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/README.md

@@ -0,0 +1,42 @@
+# Shopify API Extensions
+
+Adds some helpful functionality to the shopify API ruby gem:
+
+* Backoff support for network errors and rate limiting
+* Pagination support ala Stripe's `auto_paging_each`
+* Some helpful convenience methods on various objects
+
+Links:
+
+* [Official Shopify API](https://rubygems.org/gems/shopify_api)
+* https://github.com/Shopify/shopify_api/pull/339
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shopify_api_extensions'
+```
+
+## Usage
+
+```ruby
+ShopifyAPI::Product.auto_paging_each do |product|
+  puts "#{product.id}"
+end
+```
+
+## 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/iloveitaly/shopify_api_extensions.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shopify_api_extensions"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shopify_api_extensions.rb

@@ -0,0 +1,8 @@
+require "shopify_api_extensions/version"
+require 'shopify_api'
+
+Dir[File.join(File.dirname(__FILE__), "shopify_api_extensions/**/*.rb")].each { |f| require f }
+
+module ShopifyAPIExtensions
+
+end

data/lib/shopify_api_extensions/backoff.rb

@@ -0,0 +1,35 @@
+ShopifyAPI::Connection.class_eval do
+  alias_method :shopify_request, :request
+
+  def request(*args)
+    count = 0
+    limit = 10
+
+    begin
+      count += 1
+      shopify_request(*args)
+    rescue Exception => e
+      exceptions_to_retry = [
+        ActiveResource::ClientError,
+        Errno::ECONNRESET,
+        Errno::ETIMEDOUT,
+        Errno::EHOSTUNREACH,
+        EOFError,
+        Zlib::BufError,
+        SocketError
+      ]
+
+      if !exceptions_to_retry.include?(e.class)
+        raise
+      end
+
+      # TODO look at code instead of static string? This is brittle
+      if count >= limit || (e.class == ActiveResource::ClientError && e.message != "Failed.  Response code = 429.  Response message = Too Many Requests.")
+        raise
+      else
+        sleep(count)
+        retry
+      end
+    end
+  end
+end

data/lib/shopify_api_extensions/gift_card_adjustmnet.rb

@@ -0,0 +1,5 @@
+class ShopifyAPI::GiftCard::Adjustment < ShopifyAPI::Base
+  init_prefix :gift_card
+
+  # conditional_prefix :product
+end

data/lib/shopify_api_extensions/models.rb

@@ -0,0 +1,5 @@
+ShopifyAPI::Product.class_eval do
+  def variants
+    ShopifyAPI::Variant.auto_paging_each(product_id: self.id)
+  end
+end

data/lib/shopify_api_extensions/pagination.rb

@@ -0,0 +1,30 @@
+ShopifyAPI::Base.class_eval do
+  def self.list(params = {})
+    find(:all, params: params)
+  end
+
+  def self.auto_paging_each(opts = {})
+    opts[:limit] ||= 50
+    page_limit = opts[:limit]
+
+    total_count = self.count(opts)
+    pages = total_count/page_limit + 1
+    current_page = opts[:page] || 0
+    records = []
+
+    while current_page != pages
+      self.list(opts.merge(page: current_page)).each do |record|
+        records << record
+
+        yield(record) if block_given?
+      end
+
+      # TODO should keep incrementing until no results are returned instead of
+      #      relying on the page count when the requests were initiated
+
+      current_page += 1
+    end
+
+    records
+  end
+end

data/lib/shopify_api_extensions/version.rb

@@ -0,0 +1,3 @@
+module ShopifyAPIExtensions
+  VERSION = "0.1.0"
+end

data/shopify_api_extensions.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shopify_api_extensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shopify_api_extensions"
+  spec.version       = ShopifyAPIExtensions::VERSION
+  spec.authors       = ["Michael Bianco"]
+  spec.email         = ["mike@cliffsidemedia.com"]
+
+  spec.summary       = %q{Pagination, backoff, and other extensions to the shopify ruby API}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/iloveitaly/shopify_api_extensions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'shopify_api'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: shopify_api_extensions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Bianco
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- mike@cliffsidemedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shopify_api_extensions.rb
+- lib/shopify_api_extensions/backoff.rb
+- lib/shopify_api_extensions/gift_card_adjustmnet.rb
+- lib/shopify_api_extensions/models.rb
+- lib/shopify_api_extensions/pagination.rb
+- lib/shopify_api_extensions/version.rb
+- shopify_api_extensions.gemspec
+homepage: https://github.com/iloveitaly/shopify_api_extensions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Pagination, backoff, and other extensions to the shopify ruby API
+test_files: []