desertcart 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96786e0639aedbd1ea6b5385a9e8365233c130e03d42e5a71c0c9f36e5cf788f
+  data.tar.gz: 33e199b3fd1ddc4ec40727165de105473a995bb6c6c97a45e11daf3dd2bfe41c
+SHA512:
+  metadata.gz: 7982f5aa663b627b53c3b69c9e1f391bd397ed65f15b001929bd277cbc34ca28d69faef378eaa34a8e355344384d2ee06be1e71253793dfd48734b64fbacffb5
+  data.tar.gz: aef6ebc66f95aacae392da90c7e180f5c550344fae01f32684131733a201e6b5345332308f16003dde81fcf6217ed543af321aa56aa5e5609288ccd4adba221e

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2021-09-01
+
+- Initial release of first stable version.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in desertcart.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: .
+  specs:
+    desertcart (1.0.0)
+      ledger_sync (~> 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.8.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.1)
+    dry-initializer (3.0.4)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.5.6)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.4)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.5.6)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.5, >= 1.5.2)
+    faraday (1.7.1)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-detailed_logger (2.3.0)
+      faraday (>= 0.8, < 2)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    fingerprintable (1.2.1)
+      colorize
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    ledger_sync (2.2.0)
+      activemodel
+      colorize
+      dry-schema (~> 1.5.4)
+      dry-validation (~> 1.5.6)
+      faraday
+      faraday-detailed_logger
+      faraday_middleware
+      fingerprintable (>= 1.2.1)
+      nokogiri
+      openssl (~> 2.2.0)
+      pd_ruby
+      rack (~> 2.2.3)
+      resonad
+      simply_serializable (>= 1.5.1)
+    minitest (5.14.4)
+    multipart-post (2.1.1)
+    nokogiri (1.12.4-x86_64-linux)
+      racc (~> 1.4)
+    openssl (2.2.0)
+    pd_ruby (0.2.3)
+      colorize
+    racc (1.5.2)
+    rack (2.2.3)
+    rake (13.0.6)
+    resonad (1.4.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    simply_serializable (1.5.1)
+      fingerprintable (>= 1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  desertcart!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jozef Vaclavik
+
+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,107 @@
+# Desertcart
+
+This gem allows you to talk with Desertcart and its Marketplace API. It is build on top of ledger_sync.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'desertcart'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install desertcart
+
+## Usage
+
+### Authentication and Authorization
+
+Get tokens from API by signing in.
+
+```ruby
+require 'desertcart'
+
+client = Desertcart::Client.new
+
+resource = Desertcart::Session.new(login: 'EMAIL', password: 'password')
+
+operation = Desertcart::Session::Operations::Create.new(client: client, resource: resource)
+operation.perform
+
+Setting['DESERTCART_USER_TOKEN'] = operation.result.resource.token
+Setting['DESERTCART_USER_ID'] = operation.result.resource.user.ledger_id
+```
+
+Once you have tokens, go ahead and get tokens for your store (id: 1)
+```ruby
+client = Desertcart::Client.new(user_id: Setting['DESERTCART_USER_ID'], user_token: Setting['DESERTCART_USER_TOKEN'], store_id: nil, store_token: nil)
+
+store = Desertcart::Marketplace::Store.new(ledger_id: '1')
+
+resource = Desertcart::Marketplace::Authorization.new(store: store)
+
+operation = Desertcart::Marketplace::Authorization::Operations::Create.new(client: client, resource: resource)
+operation.perform
+
+Setting['DESERTCART_AMAZON_US_TOKEN'] = operation.result.resource.token
+Setting['DESERTCART_AMAZON_US_ID'] = operation.result.resource.store.ledger_id
+```
+
+### Verification
+
+Verify its all good.
+```ruby
+require 'desertcart'
+
+client = Desertcart::Client.new(user_id: Setting['DESERTCART_USER_ID'], user_token: Setting['DESERTCART_USER_TOKEN'], store_id: Setting['DESERTCART_AMAZON_US_ID'], store_token: Setting['DESERTCART_AMAZON_US_TOKEN'])
+
+resource = Desertcart::Marketplace::Store.new(ledger_id: 'current')
+
+operation = Desertcart::Marketplace::Store::Operations::Find.new(client: client, resource: resource)
+operation.perform
+
+operation.result.resource.ledger_id
+```
+
+### Search
+
+To get list of items/search, you need to use Searcher class.
+```ruby
+require 'desertcart'
+
+client = Desertcart::Client.new(user_id: Setting['DESERTCART_USER_ID'], user_token: Setting['DESERTCART_USER_TOKEN'], store_id: Setting['DESERTCART_AMAZON_US_ID'], store_token: Setting['DESERTCART_AMAZON_US_TOKEN'])
+
+search = Desertcart::Marketplace::OrderItem::Searcher.new(client: client, query: {})
+search.resources
+```
+
+Pending order items search with hash param.
+```ruby
+require 'desertcart'
+
+client = Desertcart::Client.new(user_id: Setting['DESERTCART_USER_ID'], user_token: Setting['DESERTCART_USER_TOKEN'], store_id: Setting['DESERTCART_AMAZON_US_ID'], store_token: Setting['DESERTCART_AMAZON_US_TOKEN'])
+
+search = Desertcart::Marketplace::PendingOrderItem::Searcher.new(client: client, query: {updated_at_eq: Time.zone.now})
+search.resources
+```
+
+## 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 the created tag, 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]/desertcart.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "desertcart"
+
+# 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/desertcart.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# require_relative 'lib/desertcart/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'desertcart'
+  # spec.version       = Desertcart::VERSION
+  spec.version       = '1.0.0'
+  spec.authors       = ['Jozef Vaclavik']
+  spec.email         = ['jozef@desertcart.com']
+
+  spec.summary       = 'Communicate with Desertcart API'
+  spec.description   = 'Client library to talk to Desertcart API. '\
+                       'Get products details, proceed with checkout '\
+                       'and retrieve informations about your orders.'
+  spec.homepage      = 'https://developer.desertcart.com'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/desertcart/desertcart-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/desertcart/desertcart-ruby/blob/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ledger_sync', '~> 2.2.0'
+end

data/lib/desertcart/authentication_token/deserializer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../user/deserializer'
+require_relative '../marketplace/store/deserializer'
+
+module Desertcart
+  class AuthenticationToken
+    class Deserializer < Desertcart::Deserializer
+      id
+      attribute :token
+      attribute :expires_at
+
+      references_one :user,
+                     hash_attribute: 'user',
+                     deserializer: Desertcart::User::Deserializer
+      references_one :store,
+                     hash_attribute: 'store',
+                     deserializer: Desertcart::Marketplace::Store::Deserializer
+    end
+  end
+end

data/lib/desertcart/authentication_token/operations/find.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Desertcart
+  class AuthenticationToken
+    module Operations
+      class Find < Desertcart::Operation::Find
+        class Contract < LedgerSync::Ledgers::Contract
+          params do
+            required(:external_id).maybe(:string)
+            required(:ledger_id).filled(:string)
+            optional(:token).maybe(:string)
+            optional(:expires_at).maybe(:string)
+            optional(:user).maybe(:hash, Types::Reference)
+            optional(:store).maybe(:hash, Types::Reference)
+          end
+        end
+      end
+    end
+  end
+end