solidus_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 656255324a849b6b35ce7a3b738a7d07e19a8886548d3f001e53a747a9c6d4de
+  data.tar.gz: c8929ce73909ecbcf9749bb9ddeb18d4de06033d452c979fb85aeac0b196d11e
+SHA512:
+  metadata.gz: 3d95074fc2ae8bd9a076c5721a8c5bd7d52ab7c3166dbf9dc057b010006f5b713441166765f043b64dd064d347c2ff85d26d9e1a52010af1010a363393e626c1
+  data.tar.gz: 2588ccf5a07b2858a36ad16b61681a16edfb420d6ba203c23545cfb1665975dd936d832847a197c81eb4dac1d4b4f4572e9ec5fcaba2e1922ac3a82d062c0a93

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Nebulab S.r.l. (https://nebulab.it)
+
+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,73 @@
+# Ruby Solidus API client
+
+## Requirements
+* [MRI 2.3+](https://www.ruby-lang.org/en/downloads)
+* [Solidus 2.9+](https://solidus.io) with [Solidus Auth (Devise)](https://github.com/solidusio/solidus_auth_devise)
+
+## Installation
+
+```
+gem install solidus_client
+```
+
+## Usage
+
+### Client class
+
+Use `SolidusClient:Client` class
+```ruby
+require 'solidus_client/client'
+
+client = SolidusClient::Client.new(url: 'app url', api_key: 'user api key')
+
+item_data_hash = { ... }
+response_hash = client.add_item(order_number, item_data_hash)
+```
+
+### Command line
+Run `solidus` command
+
+```
+$ solidus -h
+
+Usage: solidus [options] command [target] [JSON data]
+
+Commands:
+ - add_item <order_number> <data>
+ - ..
+
+Options:
+    -u, --url   Solidus URL
+    -k, --key   Solidus API key
+```
+
+## Development
+Install dependencies
+```
+bundle install
+```
+
+Export required environment Variables
+```
+export SOLIDUS_API_KEY=your API key
+export SOLIDUS_URL=Solidus endpoint
+```
+
+Run specs
+**WARNING:** `checkout_spec.rb` requires a running Solidus instance and writes Product and Order data to it
+```
+bundle exec rake spec
+```
+
+## License
+
+Copyright © 2019 [Nebulab](https://nebulab.it/).
+It is free software, and may be redistributed under the terms specified in the [license](LICENSE.txt).
+
+## About
+
+![Nebulab](http://nebulab.it/assets/images/public/logo.svg)
+
+Solidus API Client is funded and maintained by the [Nebulab](http://nebulab.it/) team.
+
+We firmly believe in the power of open-source. [Contact us](https://nebulab.it/contact-us/) if you like our work and you need help with your project design or development.

data/exe/solidus

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'solidus_client/cli'
+
+STDOUT.sync = true
+
+SolidusClient::CLI.new.run

data/lib/solidus_client.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'solidus_client/client'
+require_relative 'solidus_client/version'

data/lib/solidus_client/cli.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'solidus_client/client'
+require 'solidus_client/version'
+require 'json'
+require 'optparse'
+
+module SolidusClient
+  # The class responsible of handling command line logic
+  class CLI
+    # Entry point to start the application
+    def run
+      client = Client.new(parse_options)
+      command = ARGV.shift.to_sym
+      args = convert_data_input
+
+      result = client.send(command, *args)
+      pp result
+    rescue OptionParser::InvalidOption => e
+      abort("#{e.message}, see 'solidus --help'")
+    end
+
+    private
+
+    def parse_options
+      options = {}
+      OptionParser.new do |opts|
+        opts.version = SolidusClient::Version::STRING
+        opts_banner(opts)
+        opts_url(opts, options)
+        opts_key(opts, options)
+      end.parse!
+
+      options
+    end
+
+    def opts_banner(opts)
+      opts.banner = 'Usage: solidus [options] command [target] [JSON data]'
+      opts.separator('')
+      opts.separator("Commands:\n - #{commands_descriptions.join("\n - ")}")
+      opts.separator('')
+      opts.separator('Options:')
+    end
+
+    def opts_url(opts, options)
+      opts.on('-u', '--url [STRING]', 'Solidus URL') do |value|
+        options[:url] = value
+      end
+    end
+
+    def opts_key(opts, options)
+      opts.on('-k', '--key [STRING]', 'Solidus API key') do |value|
+        options[:api_key] = value
+      end
+    end
+
+    def commands_descriptions
+      Client.public_instance_methods(false).sort.map do |method|
+        params = Client.instance_method(method).parameters
+        "#{method} #{params_description(params)}"
+      end
+    end
+
+    def params_description(params)
+      params.map { |param| "<#{param[1]}>" }.join(' ')
+    end
+
+    def convert_data_input
+      ARGV.map do |arg|
+        begin
+          JSON.parse(arg, symbolize_names: true)
+        rescue JSON::ParserError
+          arg
+        end
+      end
+    end
+  end
+end

data/lib/solidus_client/client.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'pp'
+
+module SolidusClient
+  # Solidus API Client entrypoint
+  class Client
+    def initialize(url: nil, api_key: nil)
+      url ||= ENV['SOLIDUS_URL']
+      api_key ||= ENV['SOLIDUS_API_KEY']
+
+      @connection = Faraday.new(url: url + '/api') do |connection|
+        connection.authorization(:Bearer, api_key)
+        connection.use Faraday::Response::RaiseError
+        connection.headers['Content-Type'] = 'application/json'
+        connection.request(:json)
+        connection.response(:json, parser_options: { symbolize_names: true })
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    def states(country_id)
+      get("countries/#{country_id}/states")
+    end
+
+    def shipping_zones
+      get('zones')
+    end
+
+    def products
+      get('products')
+    end
+
+    def create_product(data = {})
+      post('products', data)
+    end
+
+    def create_order(data = {})
+      post('orders', data)
+    end
+
+    def add_item(order_number, data = {})
+      post("orders/#{order_number}/line_items", data)
+    end
+
+    def remove_item(order_number, item_id)
+      delete("orders/#{order_number}/line_items/#{item_id}")
+    end
+
+    def advance_checkout(order_number)
+      put("checkouts/#{order_number}/next")
+    end
+
+    def complete_checkout(order_number)
+      put("checkouts/#{order_number}/complete")
+    end
+
+    def update_order(order_number, data)
+      patch("orders/#{order_number}", data)
+    end
+
+    def shipping_rates(shipment_number)
+      get("shipments/#{shipment_number}/estimated_rates")
+    end
+
+    def payments
+      get('products')
+    end
+
+    def select_shipping_method(shipment_number, data)
+      put("shipments/#{shipment_number}/select_shipping_method", data)
+    end
+
+    def enter_payment_details(order_number, data)
+      post("orders/#{order_number}/payments", data)
+    end
+
+    private
+
+    def get(path)
+      request(:get, path)
+    end
+
+    def post(path, data = {})
+      request(:post, path, data)
+    end
+
+    def put(path, data = {})
+      request(:put, path, data)
+    end
+
+    def patch(path, data = {})
+      request(:patch, path, data)
+    end
+
+    def delete(path)
+      request(:delete, path)
+    end
+
+    def request(method, path, data = nil)
+      @connection.send(method, path, data).body
+    rescue Faraday::ClientError => e
+      pp e.response[:body]
+      raise
+    end
+  end
+end

data/lib/solidus_client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SolidusClient
+  module Version
+    STRING = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: solidus_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Team Nebulab
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Solidus eCommerce API Ruby client
+email: hello@nebulab.it
+executables:
+- solidus
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- exe/solidus
+- lib/solidus_client.rb
+- lib/solidus_client/cli.rb
+- lib/solidus_client/client.rb
+- lib/solidus_client/version.rb
+homepage: https://github.com/nebulab/solidus_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Solidus API Ruby client
+test_files: []