nuvemshop 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f42327f74d6d6e4bb185dd88853629b2ef035ef7e4fd26b295ec234bbeb04012
-  data.tar.gz: 39aaefb3334b0fc951a87151e841580c66ef5691e641441e1861f8f534fd126c
+  metadata.gz: 55d13102f48056bc0c30a4a698aff0807daedcd59e524a74998081dc3fad2eab
+  data.tar.gz: 594917b2e9d9d17c8871ed38f22aa3d97aff5dbbd9c649bdedff8df0a7b7e4fe
 SHA512:
-  metadata.gz: 368209d80ce189ff9ee474379570fb8c6af0c99e0534c2683d3b0a13815d38c6c61042c3bdbedff529ae8d57102a22aa1211706bfce4be5fe6464dcbd94efc33
-  data.tar.gz: f06e3f5de4822ea751de805681aed5d4bfba9038210e4acbb597faac3c0687148cb599508a2d5e073d6f9f1cc58e3e5d7b6c0b1d464c3a7b3e5629086456bcca
+  metadata.gz: 2fe42bc6093fc00bb2fa585a265b240af6fc228682370934d0fd6401aeddfa50a1b7192fabf310f19e0e6d4cb4b1674b79b204f7fb1fab2b5b633d5af4fc44ee
+  data.tar.gz: ad6e3ee539c30cfb28063fe66c54162b11cc50bb0b0826717ad8f4974f89bad30e3b4ca8144f2a437ca18862c50d8827dd226c569d4b93afc8aaaefee26d4d60

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI
+on: [pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+
+      - name: Build and run tests
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop -l
+          bundle exec rspec

data/.rspec

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

data/.rubocop.yml

@@ -11,6 +11,7 @@ AllCops:
 Layout/LineLength:
   AutoCorrect: true
   Max: 120
+  IgnoredPatterns: ['^ *# ']
 Layout/SpaceAroundMethodCallOperator:
   Enabled: false
 Layout/IndentationConsistency:
@@ -82,3 +83,11 @@ Style/SingleArgumentDig:
 Style/MutableConstant:
   Enabled: true
   AutoCorrect: true
+RSpec/FilePath:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: true
+  CountAsOne: ['array', 'heredoc', 'hash']
+  Max: 15
+RSpec/MultipleExpectations:
+  Enabled: false

data/Gemfile

@@ -2,6 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in nuvemshop.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nuvemshop (0.1.0)
+    nuvemshop (0.1.1)
       httparty (~> 0.18)
 
 GEM
@@ -10,6 +10,7 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.4.4)
+    docile (1.3.5)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
@@ -59,7 +60,14 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     unicode-display_width (2.0.0)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
@@ -72,6 +80,8 @@ DEPENDENCIES
   rubocop (~> 1.12)
   rubocop-performance (~> 1.11)
   rubocop-rspec (~> 2.2)
+  simplecov
+  yard
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,8 +1,11 @@
 # NuvemshopRuby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nuvemshop`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a Wrapper for Nuvemshop/Tiendanube API. his gem is a work in progress. If you like to contribute, please get in touch!
 
-TODO: Delete this and the text above, and describe your gem
+## Working Features
+
+- `Nuvemshop::Orders.all`
+- `Nuvemshop::Orders.show`
 
 ## Installation
 
@@ -22,19 +25,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## 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).
+If you use rails you can add this code below in `config/initializers/nuvemshop.rb`
+```
+require 'nuvemshop'
+
+Nuvemshop.configure do |config|
+  config.client_id = 'your_client_id'
+  config.client_secret = 'your_client_secret'
+  config.user_agent = 'Your Company/Name (your_email@domain.com)'
+  config.store_access_token = 'your_store_access_token'
+  config.store_user_id = 'your_user_id'
+end
+```
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nuvemshop-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/nuvemshop_ruby/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/nuvemshop.rb

@@ -1,29 +1,40 @@
 require 'pp'
 require 'httparty'
 
+require 'nuvemshop/inflections/infer_key_class_name'
+require 'nuvemshop/inflections/pascal_case'
+
 require 'nuvemshop/extensions/credentiable'
 require 'nuvemshop/extensions/mass_assignment'
 
 require 'nuvemshop/version'
 require 'nuvemshop/response'
 require 'nuvemshop/request'
+require 'nuvemshop/base_model'
+require 'nuvemshop/extras/timestampz'
+
+require 'nuvemshop/order'
+require 'nuvemshop/order/promotional_discount'
+require 'nuvemshop/order/payment_details'
+require 'nuvemshop/order/timestampz'
+require 'nuvemshop/order/address'
+require 'nuvemshop/order/client_details'
+require 'nuvemshop/product/image'
+require 'nuvemshop/product'
 require 'nuvemshop/orders'
+require 'nuvemshop/customer'
 
 module Nuvemshop
   class Error < StandardError; end
 
   class << self
     attr_accessor :client_id, :client_secret
-    attr_writer :api_version, :user_agent, :store_access_token, :store_user_id
+    attr_writer :user_agent, :store_access_token, :store_user_id
 
-    def config
+    def configure
       yield self
     end
 
-    def api_version
-      @api_version ||= 'v1'
-    end
-
     def user_agent
       @user_agent ||= 'Nuvemshop Gem(https://github.com/alexandreh92/nuvemshop-ruby)'
     end

data/lib/nuvemshop/base_model.rb

@@ -0,0 +1,46 @@
+module Nuvemshop
+  class BaseModel < Object
+    include Extensions::MassAssignment
+
+    ##
+    # Intercepts attr_acessor call, and assign it value to a variable named @attributes
+    def self.attr_accessor(*vars)
+      @attributes ||= []
+      @attributes.concat vars
+      super(*vars)
+    end
+
+    ##
+    # Getter to expose @attributes to class object
+    def self.attributes
+      @attributes
+    end
+
+    ##
+    # Getter to expose @attributes to class instance
+    def attributes
+      self.class.attributes
+    end
+
+    ##
+    # Overwrite default Ruby pretty_print(q) method to act as ActiveRecord's output
+    def pretty_print(pp)
+      pp.object_address_group(self) do
+        variables = self.class.attributes.map do |attribute|
+          attribute.to_s.delete(':')
+        end
+
+        pp.seplist(variables, proc { pp.text ',' }) do |attr_name|
+          pp.breakable ' '
+          pp.group(1) do
+            pp.text attr_name
+            pp.text ':'
+            pp.breakable
+            value = send(attr_name.to_sym) || nil
+            pp.pp value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nuvemshop/customer.rb

@@ -0,0 +1,19 @@
+module Nuvemshop
+  class Customer < BaseModel
+    attr_accessor :id, :name, :email, :identification, :phone, :note, :default_address, :addresses, :billing_name,
+                  :billing_phone, :billing_address, :billing_number, :billing_floor, :billing_locality,
+                  :billing_zipcode, :billing_city, :billing_province, :billing_country, :extra, :total_spent,
+                  :total_spent_currency, :last_order_id, :active, :created_at, :updated_at
+
+    private
+
+      def after_initialize
+        set_attributes
+      end
+
+      def set_attributes
+        @default_address = Nuvemshop::Order::Address.new(default_address)
+        @addresses = addresses&.map { |addr| Order::Address.new(addr) } || []
+      end
+  end
+end

data/lib/nuvemshop/extensions/mass_assignment.rb

@@ -1,9 +1,10 @@
 module Nuvemshop
   module Extensions
     module MassAssignment
-      def initialize(options = {})
+      # Assigns getter and setter for each pair key/value
+      def initialize(opts = {})
         before_initialize if respond_to?(:before_initialize, true)
-        options.each { |key, value| public_send("#{key}=", value) }
+        opts&.each { |key, value| public_send("#{key.to_sym}=", value) }
         after_initialize if respond_to?(:after_initialize, true)
       end
     end

data/lib/nuvemshop/extras/timestampz.rb

@@ -0,0 +1,7 @@
+module Nuvemshop
+  module Extras
+    class Timestampz < BaseModel
+      attr_accessor :date, :timezone_type, :timezone
+    end
+  end
+end

data/lib/nuvemshop/inflections/infer_key_class_name.rb

@@ -0,0 +1,9 @@
+module Nuvemshop
+  module Inflections
+    def self.infer_key_class_name(klass, key)
+      Object.const_get(klass.to_s.split('::')[0..-2].push(pascal_case(key)).join('::'))
+    rescue NameError
+      Nuvemshop::GenericModel
+    end
+  end
+end

data/lib/nuvemshop/inflections/pascal_case.rb

@@ -0,0 +1,7 @@
+module Nuvemshop
+  module Inflections
+    def self.pascal_case(key)
+      key.split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/nuvemshop/order.rb

@@ -0,0 +1,30 @@
+module Nuvemshop
+  class Order < BaseModel
+    attr_accessor :id, :token, :store_id, :shipping_min_days, :shipping_max_days, :billing_name, :billing_phone,
+                  :billing_address, :billing_number, :billing_floor, :billing_locality, :billing_zipcode, :billing_city,
+                  :billing_province, :billing_country, :shipping_cost_owner, :shipping_cost_customer, :coupon,
+                  :promotional_discount, :subtotal, :discount, :discount_coupon, :discount_gateway, :total,
+                  :total_usd, :checkout_enabled, :weight, :currency, :language, :gateway, :gateway_id, :shipping,
+                  :shipping_option, :shipping_option_code, :shipping_option_reference, :shipping_pickup_details,
+                  :shipping_tracking_number, :shipping_tracking_url, :shipping_store_branch_name, :shipping_pickup_type,
+                  :shipping_suboption, :extra, :storefront, :note, :created_at, :updated_at, :completed_at,
+                  :next_action, :payment_details, :attributes, :customer, :products, :number, :cancel_reason,
+                  :owner_note, :cancelled_at, :closed_at, :read_at, :status, :payment_status, :shipping_address,
+                  :shipping_status, :shipped_at, :paid_at, :landing_url, :client_details, :app_id
+
+    private
+
+      def after_initialize
+        assing_variables
+      end
+
+      def assing_variables
+        @promotional_discount = Order::PromotionalDiscount.new(promotional_discount)
+        @completed_at = Extras::Timestampz.new(completed_at)
+        @payment_details = Order::PaymentDetails.new(payment_details)
+        @customer = Customer.new(customer)
+        @products = products&.map { |prod| Product.new(prod) } || []
+        @client_details = Order::ClientDetails.new(client_details)
+      end
+  end
+end

data/lib/nuvemshop/order/address.rb

@@ -0,0 +1,24 @@
+module Nuvemshop
+  class Order < BaseModel
+    # @attr [String] address The address of this object.
+    # @attr [String] city The city of this object.
+    # @attr [String] country The country of this object.
+    # @attr [String] position The position of this object.
+    # @attr [String] created_at The created_at of this object.
+    # @attr [String] default The default of this object.
+    # @attr [String] floor The floor of this object.
+    # @attr [String] id The id of this object.
+    # @attr [String] locality The locality of this object.
+    # @attr [String] name The name of this object.
+    # @attr [String] number The number of this object.
+    # @attr [String] phone The phone of this object.
+    # @attr [String] updated_at The updated_at of this object.
+    # @attr [String] zipcode The zipcode of this object.
+    # @attr [String] province The province of this object.
+    # Related to {TiendaNube-Docs Order/Address}[https://github.com/tiendanube/api-docs/blob/master/resources/order.md#address]
+    class Address < BaseModel
+      attr_accessor :address, :city, :country, :created_at, :default, :floor, :id, :locality,
+                    :name, :number, :phone, :province, :updated_at, :zipcode
+    end
+  end
+end

data/lib/nuvemshop/order/client_details.rb

@@ -0,0 +1,9 @@
+module Nuvemshop
+  class Order < BaseModel
+    # @attr [String] browser_ip The browser_ip of this object.
+    # @attr [String] user_agent The user_agent of this object.
+    class ClientDetails < BaseModel
+      attr_accessor :browser_ip, :user_agent
+    end
+  end
+end

data/lib/nuvemshop/order/payment_details.rb

@@ -0,0 +1,7 @@
+module Nuvemshop
+  class Order < BaseModel
+    class PaymentDetails < BaseModel
+      attr_accessor :method, :credit_card_company, :installments
+    end
+  end
+end

data/lib/nuvemshop/order/promotional_discount.rb

@@ -0,0 +1,8 @@
+module Nuvemshop
+  class Order < BaseModel
+    class PromotionalDiscount < BaseModel
+      attr_accessor :id, :store_id, :order_id, :created_at, :total_discount_amount, :contents,
+                    :promotions_applied
+    end
+  end
+end

data/lib/nuvemshop/order/timestampz.rb

@@ -0,0 +1,6 @@
+module Nuvemshop
+  class Order < BaseModel
+    class Timestampz < Extras::Timestampz
+    end
+  end
+end

data/lib/nuvemshop/orders.rb

@@ -5,7 +5,10 @@ module Nuvemshop
     PATH = 'orders'.freeze
 
     def self.all(opts = {})
-      new(access_token: opts[:access_token], user_id: opts[:user_id]).get(
+      response = new(
+        access_token: opts[:access_token],
+        user_id: opts[:user_id]
+      ).get(
         action: PATH,
         query: {
           since_id: opts[:since_id],
@@ -27,6 +30,22 @@ module Nuvemshop
           app_id: opts[:app_id]
         }
       )
+
+      respond_with(response, Nuvemshop::Order)
+    end
+
+    def self.show(opts = {})
+      response = new(
+        access_token: opts[:access_token],
+        user_id: opts[:user_id]
+      ).get(
+        action: "#{PATH}/#{opts[:order_id]}",
+        query: {
+          fields: opts[:fields]
+        }
+      )
+
+      respond_with(response, Nuvemshop::Order)
     end
   end
 end

data/lib/nuvemshop/product.rb

@@ -0,0 +1,17 @@
+module Nuvemshop
+  class Product < BaseModel
+    attr_accessor :id, :depth, :height, :name, :price, :product_id, :image,
+                  :quantity, :free_shipping, :weight, :width, :variant_id, :variant_values,
+                  :properties, :sku, :barcode
+
+    private
+
+      def after_initialize
+        assing_variables
+      end
+
+      def assing_variables
+        @image = Product::Image.new(image)
+      end
+  end
+end

data/lib/nuvemshop/product/image.rb

@@ -0,0 +1,14 @@
+module Nuvemshop
+  class Product < BaseModel
+    # @attr [String] id The id of this object.
+    # @attr [String] product_id The product_id of this object.
+    # @attr [String] src The src of this object.
+    # @attr [String] position The position of this object.
+    # @attr [String] alt The alt of this object.
+    # @attr [String] created_at The created_at of this object.
+    # @attr [String] updated_at The updated_at of this object.
+    class Image < BaseModel
+      attr_accessor :id, :product_id, :src, :position, :alt, :created_at, :updated_at
+    end
+  end
+end

data/lib/nuvemshop/request.rb

@@ -32,12 +32,18 @@ module Nuvemshop
       perform_request(__method__, opts)
     end
 
-    private
+    def self.respond_with(response, formatter)
+      Response.new(response, formatter)
+    end
 
-      def self.respond_with(response); end
+    private
 
       def perform_request(method, opts = {})
-        self.class.send(method.to_sym, path(opts[:action]), merge_options(opts))
+        response = self.class.send(method.to_sym, path(opts[:action]), merge_options(opts))
+
+        raise Error, response unless response.success?
+
+        response
       end
 
       def merge_options(opts = {})

data/lib/nuvemshop/response.rb

@@ -1,13 +1,24 @@
 module Nuvemshop
   class Response < Object
-    attr_reader :response, :body, :code, :headers, :parsed_response
+    attr_reader :response, :body, :code, :headers, :parsed_response, :formatter
 
-    def initialize(response)
+    def initialize(response, formatter = nil)
       @response = response
       @code = response.code
       @body = response.body
       @headers = response.headers
       @parsed_response = response.parsed_response
+      @formatter = formatter
+    end
+
+    def format
+      return unless formatter
+
+      @parsed_response = if parsed_response.is_a?(Array)
+                           parsed_response.map { |pr| formatter.new(pr) }
+                         else
+                           formatter.new(parsed_response)
+                         end
     end
 
     def to_s
@@ -24,6 +35,8 @@ module Nuvemshop
     end
 
     def pretty_print(pp)
+      format
+
       if !parsed_response.nil? && parsed_response.respond_to?(:pretty_print)
         parsed_response.pretty_print(pp)
       else

data/lib/nuvemshop/version.rb

@@ -1,3 +1,3 @@
 module Nuvemshop
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'.freeze
 end

data/nuvemshop.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Alexandre Stapenhorst']
   spec.email         = ['eng.alexandreh@gmail.com']
 
-  spec.summary       = 'Write a short summary, because RubyGems requires one.'
-  spec.description   = 'Write a longer description or delete this line.'
+  spec.summary       = 'A wrapper for Nuvemshop/TiendaNube API'
+  spec.description   = 'This gem is a work in progress. If you like to contribute, please get in touch!'
   spec.homepage      = 'https://github.com/alexandreh92/nuvemshop-ruby'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
@@ -36,4 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance', '~> 1.11'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nuvemshop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexandre Stapenhorst
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-26 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -80,7 +80,64 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a longer description or delete this line.
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a work in progress. If you like to contribute, please get
+  in touch!
 email:
 - eng.alexandreh@gmail.com
 executables: []
@@ -88,6 +145,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -101,9 +159,22 @@ files:
 - bin/console
 - bin/setup
 - lib/nuvemshop.rb
+- lib/nuvemshop/base_model.rb
+- lib/nuvemshop/customer.rb
 - lib/nuvemshop/extensions/credentiable.rb
 - lib/nuvemshop/extensions/mass_assignment.rb
+- lib/nuvemshop/extras/timestampz.rb
+- lib/nuvemshop/inflections/infer_key_class_name.rb
+- lib/nuvemshop/inflections/pascal_case.rb
+- lib/nuvemshop/order.rb
+- lib/nuvemshop/order/address.rb
+- lib/nuvemshop/order/client_details.rb
+- lib/nuvemshop/order/payment_details.rb
+- lib/nuvemshop/order/promotional_discount.rb
+- lib/nuvemshop/order/timestampz.rb
 - lib/nuvemshop/orders.rb
+- lib/nuvemshop/product.rb
+- lib/nuvemshop/product/image.rb
 - lib/nuvemshop/request.rb
 - lib/nuvemshop/response.rb
 - lib/nuvemshop/version.rb
@@ -134,5 +205,5 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: A wrapper for Nuvemshop/TiendaNube API
 test_files: []