shopify_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cca7cd486238903d6162d58b335245ba3192e227
+  data.tar.gz: 53d32ca16edcfcf2976db4647f058e585635e50d
+SHA512:
+  metadata.gz: 52d697f782ef5db8c6ca257ad95f17241a7976d14c698180ba3a9071c6bbe806202caa8f728c985773165e17ed7cb2af94f728b15a9f3b3d097fd0eef16f362b
+  data.tar.gz: 000d8a63072eaa2c22b9a6faa963e23acd427033b4fdaebe5c5c70be496173fcdf386240277df31a3eec768b184859113f2fa70599e9a53771424f749f693f08

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Esteban Pastorino
+
+MIT License
+
+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,30 @@
+# ShopifyClient
+
+ShopifyClient is intended to be a thread-safe client of the Shopify API. [shopify_api](https://github.com/Shopify/shopify_api) gem is great, but due to ActiveResource dependency, it's not thread safe unfortunately.
+It's heavy influenced by the [twitter gem](https://github.com/sferik/twitter).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shopify_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shopify_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_spec.rb', 'test/**/*_test.rb']
+  t.ruby_opts = ['-r./test/test_helper.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/shopify_client.rb

@@ -0,0 +1,10 @@
+require "shopify_client/client"
+require "shopify_client/version"
+
+module ShopifyClient
+
+  def self.new(url, token, options = {})
+    Client.new url, token
+  end
+
+end

data/lib/shopify_client/api/custom_collection.rb

@@ -0,0 +1,22 @@
+require "shopify_client/custom_collection"
+
+module ShopifyClient
+  module API
+
+    module CustomCollection
+
+      def custom_collections(params = {})
+        response = get("custom_collections.json", params)
+        ShopifyClient::CustomCollection.array_from_response(response)
+      end
+
+      def custom_collection(id, params = {})
+        response = get("custom_collections/#{id}.json", params)
+        ShopifyClient::CustomCollection.from_response(response)
+      end
+
+    end
+
+  end
+end
+

data/lib/shopify_client/api/order.rb

@@ -0,0 +1,22 @@
+require "shopify_client/order"
+
+module ShopifyClient
+  module API
+
+    module Order
+
+      def orders(params = {})
+        response = get("orders.json", params)
+        ShopifyClient::Order.array_from_response(response)
+      end
+
+      def order(id, params = {})
+        response = get("orders/#{id}.json", params)
+        ShopifyClient::Order.from_response(response)
+      end
+
+    end
+
+  end
+end
+

data/lib/shopify_client/api/product.rb

@@ -0,0 +1,21 @@
+require "shopify_client/product"
+
+module ShopifyClient
+  module API
+
+    module Product
+
+      def products(params = {})
+        response = get("products.json", params)
+        ShopifyClient::Product.array_from_response(response)
+      end
+
+      def product(id, params = {})
+        response = get("products/#{id}.json", params)
+        ShopifyClient::Product.from_response(response)
+      end
+
+    end
+
+  end
+end

data/lib/shopify_client/api/recurring_application_charge.rb

@@ -0,0 +1,43 @@
+require "shopify_client/recurring_application_charge"
+
+module ShopifyClient
+  module API
+
+    module RecurringApplicationCharge
+
+      def recurring_application_charges(params = {})
+        response = get("recurring_application_charges.json", params)
+        ShopifyClient::RecurringApplicationCharge.array_from_response(response)
+      end
+
+      def current_recurring_application_charge(params = {})
+        charges = recurring_application_charges(params)
+        charges.find{|charge| charge.status == 'active' }
+      end
+
+      def recurring_application_charge(id, params = {})
+        response = get("recurring_application_charges/#{id}.json", params)
+        ShopifyClient::RecurringApplicationCharge.from_response(response)
+      end
+
+      def create_recurring_application_charge(attributes)
+        response = post("recurring_application_charges.json", recurring_application_charge: attributes)
+        ShopifyClient::RecurringApplicationCharge.from_response(response)
+      end
+
+      def activate_recurring_application_charge(id_or_object)
+        id = id_or_object.is_a?(ShopifyClient::RecurringApplicationCharge) ? id_or_object.id : id_or_object
+        post("recurring_application_charges/#{id}/activate.json")
+        true
+      end
+
+      def cancel_recurring_application_charge(id_or_object)
+        id = id_or_object.is_a?(ShopifyClient::RecurringApplicationCharge) ? id_or_object.id : id_or_object
+        delete("recurring_application_charges/#{id}.json")
+        true
+      end
+
+    end
+
+  end
+end

data/lib/shopify_client/api/script_tag.rb

@@ -0,0 +1,35 @@
+require "shopify_client/script_tag"
+
+module ShopifyClient
+  module API
+
+    module ScriptTag
+
+      def script_tags(params = {})
+        response = get("script_tags.json", params)
+        ShopifyClient::ScriptTag.array_from_response(response)
+      end
+
+      def script_tag(id, params = {})
+        response = get("script_tags/#{id}.json", params)
+        ShopifyClient::ScriptTag.from_response(response)
+      end
+
+      def create_script_tag(attributes)
+        response = post("script_tags.json", script_tag: attributes)
+        ShopifyClient::ScriptTag.from_response(response)
+      end
+
+      def destroy_script_tag(id_or_object)
+        id = id_or_object.is_a?(ShopifyClient::ScriptTag) ? id_or_object.id : id_or_object
+        delete("script_tags/#{id}.json")
+        true
+      end
+
+    end
+
+  end
+end
+
+
+

data/lib/shopify_client/api/shop.rb

@@ -0,0 +1,16 @@
+require "shopify_client/shop"
+
+module ShopifyClient
+  module API
+
+    module Shop
+
+      def shop(params = {})
+        response = get("shop.json", params)
+        ShopifyClient::Shop.from_response(response)
+      end
+
+    end
+
+  end
+end

data/lib/shopify_client/api/smart_collection.rb

@@ -0,0 +1,22 @@
+require "shopify_client/smart_collection"
+
+module ShopifyClient
+  module API
+
+    module SmartCollection
+
+      def smart_collections(params = {})
+        response = get("smart_collections.json", params)
+        ShopifyClient::SmartCollection.array_from_response(response)
+      end
+
+      def smart_collection(id, params = {})
+        response = get("smart_collections/#{id}.json", params)
+        ShopifyClient::SmartCollection.from_response(response)
+      end
+
+    end
+
+  end
+end
+

data/lib/shopify_client/api/webhook.rb

@@ -0,0 +1,34 @@
+require "shopify_client/webhook"
+
+module ShopifyClient
+  module API
+
+    module Webhook
+
+      def webhooks(params = {})
+        response = get("webhooks.json", params)
+        ShopifyClient::Webhook.array_from_response(response)
+      end
+
+      def webhook(id, params = {})
+        response = get("webhooks/#{id}.json", params)
+        ShopifyClient::Webhook.from_response(response)
+      end
+
+      def create_webhook(attributes)
+        response = post("webhooks.json", webhook: attributes)
+        ShopifyClient::Webhook.from_response(response)
+      end
+
+      def destroy_webhook(id_or_object)
+        id = id_or_object.is_a?(ShopifyClient::Webhook) ? id_or_object.id : id_or_object
+        delete("webhooks/#{id}.json")
+        true
+      end
+
+    end
+
+  end
+end
+
+

data/lib/shopify_client/base.rb

@@ -0,0 +1,57 @@
+module ShopifyClient
+  class Base
+
+    attr_reader :attributes
+    alias to_h attributes
+    alias to_hash attributes
+    alias to_hsh attributes
+
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    def self.hattr_reader(*attrs)
+      mod = Module.new do
+        attrs.each do |attribute|
+          define_method attribute do
+            @attributes[attribute.to_sym]
+          end
+          define_method "#{attribute}?" do
+            !!@attributes[attribute.to_sym]
+          end
+        end
+      end
+      const_set(:HashAttributes, mod)
+      include mod
+    end
+
+    def self.from_response(response)
+      new parse_single(response[:body])
+    end
+
+    def self.array_from_response(response)
+      parse_array(response[:body]).map do |attributes|
+        new attributes
+      end
+    end
+
+    def self.parse_single(body)
+      if body
+        body[single_name]
+      else
+        {}
+      end
+    end
+
+    def self.parse_array(body)
+      if body
+        body[plural_name]
+      else
+        []
+      end
+    end
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+
+  end
+end

data/lib/shopify_client/client.rb

@@ -0,0 +1,91 @@
+require 'faraday'
+require 'shopify_client/api/custom_collection'
+require 'shopify_client/api/order'
+require 'shopify_client/api/product'
+require 'shopify_client/api/recurring_application_charge'
+require 'shopify_client/api/script_tag'
+require 'shopify_client/api/shop'
+require 'shopify_client/api/smart_collection'
+require 'shopify_client/api/webhook'
+require 'shopify_client/request/content_type'
+require 'shopify_client/response/parse_json'
+require 'shopify_client/response/raise_error'
+
+module ShopifyClient
+
+  class Client
+    include ShopifyClient::API::CustomCollection
+    include ShopifyClient::API::Order
+    include ShopifyClient::API::Product
+    include ShopifyClient::API::RecurringApplicationCharge
+    include ShopifyClient::API::ScriptTag
+    include ShopifyClient::API::Shop
+    include ShopifyClient::API::SmartCollection
+    include ShopifyClient::API::Webhook
+
+    def self.normalize_url(url)
+       myshopify_domain = url.match(/(https?:\/\/)?(.+\.myshopify\.com)/)
+       if myshopify_domain
+         myshopify_domain = myshopify_domain[2]
+         "https://#{myshopify_domain}/admin"
+       end
+    end
+
+    def initialize(url, token, options = {})
+      @token = token
+      @url = self.class.normalize_url url
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={})
+      request(:post, path, params)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, params={})
+      request(:put, path, params)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+    private
+
+    def request(method, path, params)
+      connection.send(method.to_sym, path, params).env
+    end
+
+    def connection
+      @connection ||= Faraday.new(@url, connection_options)
+    end
+
+    def connection_options
+      {
+        :headers => {
+          :accept => 'application/json',
+          :user_agent => "ShopifyClient Ruby Gem #{ShopifyClient::VERSION}",
+          'X-Shopify-Access-Token' => @token
+        },
+        :builder => connection_middleware
+      }
+    end
+
+    def connection_middleware
+      @builder ||= Faraday::Builder.new do |builder|
+        builder.use ShopifyClient::Request::ContentType
+        builder.use ShopifyClient::Response::RaiseError
+        builder.use ShopifyClient::Response::ParseJson
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+  end
+
+end