spree-api-client 0.0.2 → 0.2.4

data/README.md

@@ -1,18 +1,12 @@
-# Spree::API::Client
-
-[![Build Status](https://secure.travis-ci.org/andrew/spree-api-client.png)](https://travis-ci.org/andrew/spree-api-client)
-
-** Beware: very alpha and untested **
-
-A rubygem for interacting with the Spree API: http://api.spreecommerce.com/v1/
-
-Heavily inspired by the excellent Octokit: https://github.com/pengwynn/octokit
+# Spree Ecommerce API client
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your site's Gemfile:
 
-    gem 'spree-api-client'
+```ruby
+gem 'spree_client'
+```
 
 And then execute:
 
@@ -20,42 +14,41 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install spree-api-client
+    $ gem install spree_client
 
 ## Usage
 
-    client = Spree::API::Client.new('http://example/api', 'yourapitokenstring')
-    products = client.products
+Get an API key for your user in `/admin/users`.
+
+```ruby
+spree = SpreeClient::Api::V1.new api_key: 'api key', spree_url: 'http://localhost:3000', store: 'https://my.store'
+
+spree.products.index
+=> true
 
-## TODO
+# The results are in the response
+spree.products.response
+=> []
+```
 
-* More tests
-* Mock web requests in tests
-* documentation
-* rdoc generation
-* release to rubygems.org
-* gemnasium
-* code climate
-* Error handling
-* Autopagination?
+[Read the documentation](https://rubydoc.info/gems/spree_client)
 
-## Development
 
-Source hosted at [GitHub](http://github.com/andrew/spree-api-client).
-Report Issues/Feature requests on [GitHub Issues](http://github.com/andrew/spree-api-client/issues).
+## Contributing
 
-Tests can be ran with `rake spec`
+Bug reports and pull requests are welcome on 0xacab.org at
+<https://0xacab.org/sutty/spree_client>. This project is
+intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Sutty code of
+conduct](https://sutty.nl/en/code-of-conduct/).
 
-### Note on Patches/Pull Requests
+## License
 
- * Fork the project.
- * Make your feature addition or bug fix.
- * Add tests for it. This is important so I don't break it in a
-   future version unintentionally.
- * Commit, do not mess with rakefile, version, or history.
-   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
- * Send me a pull request. Bonus points for topic branches.
+The gem is available as free software under the terms of the GPL3
+License.
 
-## Copyright
+## Code of Conduct
 
-Copyright (c) 2013 Andrew Nesbitt. See [LICENSE](https://github.com/andrew/spree-api-client/blob/master/LICENSE) for details.
+Everyone interacting in the `spree_client` project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code
+of conduct](https://sutty.nl/en/code-of-conduct/).

data/lib/spree_client/api/v1/products.rb

@@ -0,0 +1,23 @@
+module SpreeClient
+  module API
+    class V1
+      # Products
+      # @see SpreeClient::API:V1::Resource
+      class Products < Resources
+        ENDPOINT = '/api/v1/products'
+        RESOURCE = SpreeClient::Models::Product
+        NAME     = 'product'
+
+        # @return [SpreeClient::API::V1::Variants]
+        def variants(**args)
+          product_id = default_args.dig(:id) || args.dig(:product_id)
+
+          raise ArgumentError, 'Needs a product ID' unless product_id
+
+          @variants ||= {}
+          @variants[product_id.to_s.to_sym] ||= Variants.new **{ api: api, product_id: product_id }.merge(args)
+        end
+      end
+    end
+  end
+end

data/lib/spree_client/api/v1/properties.rb

@@ -0,0 +1,12 @@
+class SpreeClient
+  module API
+    class V1
+      # Properties
+      # @see SpreeClient::API:V1::Resource
+      class Properties < Resources
+        ENDPOINT = '/api/v1/properties'
+        RESOURCE = Property
+      end
+    end
+  end
+end

data/lib/spree_client/api/v1/resources.rb

@@ -0,0 +1,142 @@
+require 'uri'
+
+module SpreeClient
+  module API
+    class V1
+      class Resources
+        # Spree API client instance.
+        # @return [SpreeClient::API::V1]
+        attr_reader :api
+        # Every method caches the response so it can be inspected afterwards.
+        # @return [HTTParty::Response] The API response
+        attr_reader :response
+        # @return [Hash]
+        attr_reader :default_args
+
+        # Initialize
+        #
+        # @param [SpreeClient::API::V1] :api An API client instance
+        def initialize(**args)
+          @api = args.delete :api
+          @default_args = args
+        end
+
+        # Initialize a new resource
+        #
+        # @param [Hash] Attributes
+        # @return [Struct]
+        def new(**args)
+          resource_class.new **args
+        end
+
+        # Gets all products or filter with params
+        #
+        # Filters:
+        #
+        # ids: comma-separated list of IDs
+        # q: Ransack search params (mutually exclusive with ids)
+        #
+        # Pagination:
+        #
+        # page: page number
+        # per_page: results per page
+        #
+        # @param [Hash] Query params
+        def index(**q)
+          @response = api.class.get endpoint(q),
+                                    query: q.slice(:ids, :q, :page, :per_page),
+                                    headers: api.headers
+
+          response.ok?
+        end
+
+        # Get a single product by ID
+        def show(resource)
+          @response = api.class.get endpoint(resource), headers: api.headers
+
+          response.ok?
+        end
+
+        # Creates a resource
+        #
+        # @see SpreeClient::API::V1#headers
+        # @param [Struct,Hash] Model instance
+        # @return [Boolean]
+        def create(resource)
+          resource = new **resource unless resource.is_a? resource_class
+
+          @response = api.class.post endpoint(resource),
+                                     body: params(resource),
+                                     headers: api.headers
+
+          response.created?
+        end
+
+        # Updates a resource
+        #
+        # @see SpreeClient::API::V1#headers
+        # @param [Struct,Hash]
+        # @return [Boolean]
+        def update(resource)
+          resource = new resource unless resource.is_a? resource_class
+
+          @response = api.class.patch endpoint(resource),
+                                      body: params(resource),
+                                      headers: api.headers
+
+          response.ok?
+        end
+
+        # Deletes a resource
+        #
+        # @see SpreeClient::API::V1#headers
+        # @param [Struct,Hash]
+        # @return [Boolean]
+        def delete(resource)
+          @response = spree.class.delete endpoint(resource), headers: api.headers
+
+          response.no_content?
+        end
+
+        private
+
+        # Strong parameters
+        #
+        # @see SpreeClient#authenticity_token
+        # @param [Struct,Nil]
+        # @return [Hash]
+        def params(resource = nil)
+          { resource_name => default_args.merge(resource.to_h.compact) }.to_json
+        end
+
+        # Backend endpoint
+        #
+        # @param [Struct]
+        # @return [String]
+        def endpoint(resource = {})
+          endpoint = self.class::ENDPOINT + (resource.dig(:id) ? '/:id' : '')
+
+          parameterize_with endpoint, resource
+        end
+
+        # Generates a URL with :parameter replaced with values
+        # 
+        # @param [String]
+        # @param [Struct,Hash]
+        def parameterize_with(endpoint, resource = {})
+          default_args.merge(resource.to_h.compact).inject(endpoint) do |e, pair|
+            e.gsub ':' + pair.first.to_s, pair.last.to_s
+          end + '.json'
+        end
+
+        def resource_class
+          self.class::RESOURCE
+        end
+
+        def resource_name
+          self.class::NAME
+        end
+      end
+    end
+  end
+end

data/lib/spree_client/api/v1/stock_items.rb

@@ -0,0 +1,27 @@
+module SpreeClient
+  module API
+    class V1
+      # Stock Movements
+      # @see SpreeClient::API:V1::Resources
+      class StockItems < Resources
+        ENDPOINT = '/api/v1/stock_locations/:stock_location_id/stock_items'
+        RESOURCE = SpreeClient::Models::StockItem
+        NAME     = 'stock_item'
+
+        def update(_); end
+        def destroy(_); end
+
+        # @return [SpreeClient::API::V1::StockMovements]
+        def stock_movements(**args)
+          stock_location_id = default_args.dig(:stock_location_id) || args.dig(:stock_location_id)
+          stock_item_id = default_args.dig(:id) || args.dig(:stock_item_id)
+
+          raise ArgumentError, 'Needs a stock location ID' unless stock_location_id
+
+          @stock_movements ||= {}
+          @stock_movements[stock_location_id.to_s.to_sym] ||= StockMovements.new **{ api: api, stock_location_id: stock_location_id, stock_item_id: stock_item_id }.merge(args)
+        end
+      end
+    end
+  end
+end

data/lib/spree_client/api/v1/stock_locations.rb

@@ -0,0 +1,33 @@
+module SpreeClient
+  module API
+    class V1
+      # Stock Locations
+      # @see SpreeClient::API:V1::Resource
+      class StockLocations < Resources
+        ENDPOINT = '/api/v1/stock_locations'
+        RESOURCE = SpreeClient::Models::StockLocation
+        NAME     = 'stock_location'
+
+        # @return [SpreeClient::API::V1::StockMovements]
+        def stock_movements(**args)
+          stock_location_id = default_args.dig(:id) || args.dig(:stock_location_id)
+
+          raise ArgumentError, 'Needs a stock location ID' unless stock_location_id
+
+          @stock_movements ||= {}
+          @stock_movements[stock_location_id.to_s.to_sym] ||= StockMovements.new **{ api: api, stock_location_id: stock_location_id }.merge(args)
+        end
+
+        # @return [SpreeClient::API::V1::StockItems]
+        def stock_items(**args)
+          stock_location_id = default_args.dig(:id) || args.dig(:stock_location_id)
+
+          raise ArgumentError, 'Needs a stock location ID' unless stock_location_id
+
+          @stock_items ||= {}
+          @stock_items[stock_location_id.to_s.to_sym] ||= StockItems.new **{ api: api, stock_location_id: stock_location_id }.merge(args)
+        end
+      end
+    end
+  end
+end

data/lib/spree_client/api/v1/stock_movements.rb

@@ -0,0 +1,16 @@
+module SpreeClient
+  module API
+    class V1
+      # Stock Movements
+      # @see SpreeClient::API:V1::Resources
+      class StockMovements < Resources
+        ENDPOINT = '/api/v1/stock_locations/:stock_location_id/stock_movements'
+        RESOURCE = SpreeClient::Models::StockMovement
+        NAME     = 'stock_movement'
+
+        def update(_); end
+        def destroy(_); end
+      end
+    end
+  end
+end

data/lib/spree_client/api/v1/taxonomies.rb

@@ -0,0 +1,12 @@
+class SpreeClient
+  module API
+    class V1
+      # Taxonomies
+      # @see SpreeClient::API:V1::Resource
+      class Taxonomies < Resources
+        ENDPOINT = '/api/v1/taxonomies'
+        RESOURCE = Taxonomy
+      end
+    end
+  end
+end

data/lib/spree_client/api/v1/variants.rb

@@ -0,0 +1,13 @@
+module SpreeClient
+  module API
+    class V1
+      # Variants
+      # @see SpreeClient::API:V1::Resource
+      class Variants < Resources
+        ENDPOINT = '/api/v1/variants'
+        RESOURCE = SpreeClient::Models::Variant
+        NAME     = 'variant'
+      end
+    end
+  end
+end

data/lib/spree_client/api/v1.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+require_relative 'v1/resources'
+require_relative 'v1/products'
+require_relative 'v1/variants'
+require_relative 'v1/stock_locations'
+require_relative 'v1/stock_items'
+require_relative 'v1/stock_movements'
+
+module SpreeClient
+  module API
+    class V1
+      include ::HTTParty
+
+      attr_reader :api_key, :store
+
+      def initialize(api_key:, spree_url: 'http://localhost:3000', store: nil)
+        @api_key = api_key
+        @store = HTTParty.normalize_base_uri(store) if store
+        self.class.default_options[:base_uri] = HTTParty.normalize_base_uri(spree_url)
+      end
+
+      # TODO: Meta programming
+      def products(**args)
+        @products ||= {}
+        @products[args.hash.to_s] ||= Products.new **{ api: self }.merge(args)
+      end
+
+      def variants(**args)
+        @variants ||= {}
+        @variants[args.hash.to_s] ||= Variants.new **{ api: self }.merge(args)
+      end
+
+      def stock_locations(**args)
+        @stock_locations ||= {}
+        @stock_locations[args.hash.to_s] ||= StockLocations.new **{ api: self }.merge(args)
+      end
+
+      def stock_movements(**args)
+        @stock_movements ||= {}
+        @stock_movements[args.hash.to_s] ||= StockMovements.new **{ api: self }.merge(args)
+      end
+
+      def stock_items(**args)
+        @stock_items ||= {}
+        @stock_items[args.hash.to_s] ||= StockItems.new **{ api: self }.merge(args)
+      end
+
+      def headers(extra = {})
+        extra.merge({ 'Content-Type' => 'application/json', 'X-Spree-Token' => api_key, 'Origin' => store })
+      end
+    end
+  end
+end

data/lib/spree_client/api.rb

@@ -0,0 +1 @@
+require_relative 'api/v1'

data/lib/spree_client/attributes.rb

@@ -0,0 +1,28 @@
+module SpreeClient
+  # @see Spree::PermittedAttributes
+  class Attributes
+    PRODUCT = %i[id name description available_on discontinue_on
+                 permalink meta_description meta_keywords meta_title
+                 price sku deleted_at prototype_id option_values_hash
+                 weight height width depth shipping_category_id
+                 tax_category_id cost_currency cost_price
+                 option_type_ids taxon_ids pay_what_you_can
+                 extra_attributes].freeze
+
+    VARIANT = %i[id name presentation cost_price discontinue_on
+                 lock_version position track_inventory product_id
+                 product option_values_attributes price weight height
+                 width depth sku cost_currency options
+                 option_value_ids].freeze
+
+    STOCK_LOCATION = %i[name active address1 address2 city zipcode
+                        backorderable_default state_name state_id
+                        country_id phone propagate_all_variants].freeze
+
+    STOCK_ITEM = %i[stock_location_id variant stock_location backorderable variant_id].freeze
+
+    STOCK_MOVEMENT = %i[id stock_location_id quantity stock_item
+                        stock_item_id originator action].freeze
+
+  end
+end

data/lib/spree_client/models/product.rb

@@ -0,0 +1,7 @@
+module SpreeClient
+  module Models
+    # @see Spree::Product
+    # @see SpreeClient::Attributes
+    Product = Struct.new *Attributes::PRODUCT, keyword_init: true
+  end
+end

data/lib/spree_client/models/property.rb

@@ -0,0 +1,6 @@
+# @see Spree::Property
+Property = Struct.new :id, :name, :presentation, keyword_init: true do
+  def to_s
+    'property'.freeze
+  end
+end

data/lib/spree_client/models/stock_item.rb

@@ -0,0 +1,7 @@
+module SpreeClient
+  module Models
+    # @see Spree::StockItem
+    # @see SpreeClient::Attributes
+    StockItem = Struct.new *Attributes::STOCK_ITEM, keyword_init: true
+  end
+end

data/lib/spree_client/models/stock_location.rb

@@ -0,0 +1,7 @@
+module SpreeClient
+  module Models
+    # @see Spree::StockLocation
+    # @see SpreeClient::Attributes
+    StockLocation = Struct.new *Attributes::STOCK_LOCATION, keyword_init: true
+  end
+end

data/lib/spree_client/models/stock_movement.rb

@@ -0,0 +1,7 @@
+module SpreeClient
+  module Models
+    # @see Spree::StockMovement
+    # @see SpreeClient::Attributes
+    StockMovement = Struct.new *Attributes::STOCK_MOVEMENT, keyword_init: true
+  end
+end

data/lib/spree_client/models/store.rb

@@ -0,0 +1,7 @@
+# Stores are different frontends for the same backend.
+#
+# @see {https://guides.spreecommerce.org/user/configuration/configuring_multi_stores.html}
+Store = Struct.new :id, :name, :url,
+                   :seo_title, :meta_description, :meta_keywords,
+                   :mail_from_address, :default_currency,
+                   :facebook, :twitter, :instagram, keyword_init: true

data/lib/spree_client/models/taxonomy.rb

@@ -0,0 +1,5 @@
+Taxonomy = Struct.new :id, :name, keyword_init: true do
+  def to_s
+    'taxonomy'.freeze
+  end
+end

data/lib/spree_client/models/variant.rb

@@ -0,0 +1,7 @@
+module SpreeClient
+  module Models
+    # @see Spree::Variant
+    # @see SpreeClient::Attributes
+    Variant = Struct.new *Attributes::VARIANT, keyword_init: true
+  end
+end

data/lib/spree_client/models.rb

@@ -0,0 +1,5 @@
+require_relative 'models/product'
+require_relative 'models/variant'
+require_relative 'models/stock_location'
+require_relative 'models/stock_item'
+require_relative 'models/stock_movement'

data/lib/spree_client.rb

@@ -0,0 +1,3 @@
+require_relative 'spree_client/attributes'
+require_relative 'spree_client/models'
+require_relative 'spree_client/api/v1'

data/lib/spree_client.rb~

@@ -0,0 +1,71 @@
+require 'httparty'
+
+require_relative 'spree_client/models'
+require_relative 'spree_client/api/v1'
+
+# This class is a client for Spree Commerce Backend.  It can push
+# information to it and also retrieve it from the APIs.
+#
+# The Spree Backend needs to have Devise configured with
+# http_authenticatable = true so it can send the credentials as basic
+# authorization header.
+module SpreeClient
+  include HTTParty
+
+  # The backend will redirect in certain actions, we want to be able to
+  # distinguish them.
+  follow_redirects false
+
+  # Cookies
+  # @return [String]
+  attr_accessor :cookies
+
+  # Initialize an SpreeClient.  If not parameters are given it'll try to
+  # login to the default development Spree.
+  #
+  # @param [String] :spree_url The Spree site
+  # @param [String] :username Username
+  # @param [String] :password Password
+  def initialize(spree_url: 'http://localhost:3000', username: 'spree@example.com', password: 'spree123')
+    self.class.basic_auth username, password
+    self.class.default_options[:base_uri] = HTTParty.normalize_base_uri(spree_url)
+  end
+
+  # Gets an authenticity token from the API by sending credentials to a
+  # custom API endpoint.  Otherwise we have to download and parse the
+  # forms.  It stores the cookie so the token can be verified afterwards.
+  #
+  # @see SpreeClient#cookies
+  # @return [String]
+  def authenticity_token
+    response = self.class.get('/admin/authenticity_token',
+                              headers: headers)
+
+    @cookies = response.headers['set-cookie']
+
+    response.to_s
+  end
+
+  # Taxonomies
+  #
+  # @see SpreeClient::Taxonomies
+  # @return [SpreeClient::Taxonomies]
+  def taxonomies
+    @taxonomies ||= Taxonomies.new spree: self
+  end
+
+  # Properties
+  #
+  # @see SpreeClient::Properties
+  # @return [SpreeClient::Properties]
+  def properties
+    @properties ||= Properties.new spree: self
+  end
+
+  # Default headers.  If there're cookies it sends them.
+  #
+  # @return [Hash] Headers
+  def headers(extra = {})
+    extra.merge({ 'Cookie' => cookies })
+  end
+end