vtex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e42153c814c60f7b91bb8af9191a6fbe900020b
+  data.tar.gz: 515477e7229022f6316f9606581f95ccd61c53d9
+SHA512:
+  metadata.gz: ffcf04b2e79513c9b8eb8124f5fb7ebabbf73e8ba09fc4c1d91505e01ba61e4dcdff6c9cf72be67d80defb8edb4daa745a1df0993eed2fb3bc34d25de01d3778
+  data.tar.gz: 902f0e105611e1f3ed56fa06c98ec1296ef07f7c786b28fd0bb8a470f9edfe6886475ea57ca9f5c1ba1b014487c6743276a5d7af93c9f20f2ff9c626409ced3a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install:
+  - gem install bundler -v 1.15.3
+script:
+  - bundle exec rspec ./spec

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'simplecov'
+gem 'activesupport'
+
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mumo Carlos
+
+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,110 @@
+# Vtex
+
+Vtex API client ruby implementation
+
+[![Build Status](https://travis-ci.org/mumoc/vtex.svg?branch=master)](https://travis-ci.org/mumoc/vtex)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vtex'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vtex
+
+
+## Usage
+
+You'll need to gatter the following information from your VTex account
+
+- **X-VTEX-API-AppKey**
+
+	Email from a user with access to the API.
+
+- **X-VTEX-API-AppToken**
+
+	VTEXId password of the user with access to the API.
+
+- **Account name**
+
+	VTex account name.
+
+- **Environment**:
+	- Use `vtexcommercestable` for production
+	- Use `vtexcommmercebeta` for tests
+
+*Note: It's recommended that you create an specific user to access the API ([vtex-auth](http://help.vtex.com/en/faq/how-do-you-authenticate-in-the-api))*
+
+
+With all the information retrieve a client instance with it.
+
+```ruby
+client = Vtex::Client.new({ account_name: "demo",
+                            environment: "vtexcommercebeta",
+                            app_key: "api.user@email.com",
+                            app_token: "VTEXIdPassword" })
+```
+
+## Design
+
+VTex follows a design of resources as methods on the client. For example, for Products, you will call your client like this:
+
+```ruby
+client = Vtex::Client.new({ ... })
+client.products #=> ProductsResource
+
+```
+
+VTex will return PORO objects that contain the information provided by the API. For example:
+
+```ruby
+client.products.by_id(id: 1)
+# => Vtex::Product (Id:1, Name: "Guarda-Roupa Casal Lisboa 10 Portas 3 Gavetas - Araplac", ...)
+```
+
+*Note: Right now, Key Values are being used as they come from the API*
+
+# All Resources and actions.
+
+All resources, methods and properties are direct matches from the [VTex API](http://help.vtex.com/en/developer-docs)
+
+## Products resource
+
+Vtex API: [Catalog System - Product](https://documenter.getpostman.com/view/845/catalogsystem-102/Hs44#ee16e494-d3b0-36f0-cfed-219aef3f155e)
+
+**Usage:**
+
+```ruby
+client = Vtex::Client.new({ ... })
+client.products #=> ProductsResource
+```
+
+**Actions supported:**
+
+* `client.products.by_id(id: 'id')`
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mumoc/vtex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Vtex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mumoc/vtex/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vtex"
+
+# 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/lib/vtex.rb

@@ -0,0 +1,18 @@
+require "vtex/version"
+require "active_support/all"
+require "resource_kit"
+require "kartograph"
+
+module Vtex
+  autoload :Client, "vtex/client"
+
+  # Models
+  autoload :Base, 'vtex/models/base'
+  autoload :Product, 'vtex/models/product'
+
+  # Resources
+  autoload :ProductResource, "vtex/resources/product_resource"
+
+  # Mappings
+  autoload :ProductMapping, "vtex/mappings/product_mapping"
+end

data/lib/vtex/client.rb

@@ -0,0 +1,61 @@
+require 'faraday'
+
+module Vtex
+  class Client
+    VTEX_API_BASE = "http://accountName.environment.com.br"
+
+    attr_reader :account_name, :environment, :app_key, :app_token
+
+    def initialize(options = {})
+      @account_name = options[:account_name]
+      @environment  = options[:environment]
+      @app_key      = options[:app_key]
+      @app_token    = options[:app_token]
+    end
+
+    def connection
+      @faraday ||= Faraday.new connection_options do |request|
+        request.adapter :net_http
+      end
+    end
+
+    def self.resources
+      {
+        products: ProductResource
+      }
+    end
+
+    def method_missing(name, *args, &block)
+      if self.class.resources.keys.include?(name)
+        resources[name] ||= self.class.resources[name].new(connection: connection)
+        resources[name]
+      else
+        super
+      end
+    end
+
+    def resources
+      @resources ||= {}
+    end
+
+    private
+
+    def vtex_api
+      VTEX_API_BASE.gsub(/accountName|environment/,
+                         'accountName' => account_name,
+                         'environment' => environment)
+    end
+
+    def connection_options
+      {
+        url: vtex_api,
+        headers: {
+          content_type: 'application/json',
+          "X-VTEX-API-AppKey" => app_key,
+          "X-VTEX-API-AppToken" => app_token
+        }
+      }
+    end
+  end
+end
+

data/lib/vtex/mappings/product_mapping.rb

@@ -0,0 +1,31 @@
+module Vtex
+  class ProductMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Product
+
+      property :Id, scopes: [:read]
+      property :Name, scopes: [:read]
+      property :DepartmentId, scopes: [:read]
+      property :CategoryId, scopes: [:read]
+      property :BrandId, scopes: [:read]
+      property :LinkId, scopes: [:read]
+      property :RefId, scopes: [:read]
+      property :IsVisible, scopes: [:read]
+      property :Description, scopes: [:read]
+      property :DescriptionShort, scopes: [:read]
+      property :ReleaseDate, scopes: [:read]
+      property :KeyWords, scopes: [:read]
+      property :Title, scopes: [:read]
+      property :IsActive, scopes: [:read]
+      property :TaxCode, scopes: [:read]
+      property :MetaTagDescription, scopes: [:read]
+      property :SupplierId, scopes: [:read]
+      property :ShowWithoutStock, scopes: [:read]
+      property :ListStoreId, scopes: [:read]
+      property :AdWordsRemarketingCode, scopes: [:read]
+      property :LomadeeCampaignCode, scopes: [:read]
+    end
+  end
+end

data/lib/vtex/models/base.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+
+module Vtex
+  class Base
+    include Virtus.model
+    include Virtus::Equalizer.new(name || inspect)
+
+    def inspect
+      values = Hash[instance_variables.map { |name| [name, instance_variable_get(name)] } ]
+      "<#{self.class.name} #{values}>"
+    end
+  end
+end

data/lib/vtex/models/product.rb

@@ -0,0 +1,10 @@
+module Vtex
+  class Product < Base
+    [:Id, :Name, :DepartmentId, :CategoryId, :BrandId, :LinkId, :RefId, :IsVisible,
+     :Description, :DescriptionShort, :ReleaseDate, :KeyWords, :Title, :IsActive,
+     :TaxCode, :MetaTagDescription, :SupplierId, :ShowWithoutStock, :ListStoreId,
+     :AdWordsRemarketingCode, :LomadeeCampaignCode].each do |key|
+      attribute(key)
+    end
+  end
+end

data/lib/vtex/resources/product_resource.rb

@@ -0,0 +1,10 @@
+module Vtex
+  class ProductResource < ResourceKit::Resource
+    resources do
+      action :by_id, 'GET /api/catalog_system/pvt/products/ProductGet/:id' do
+        handler(200) { |response| ProductMapping.extract_single(response.body, :read) }
+      end
+    end
+  end
+end
+

data/lib/vtex/version.rb

@@ -0,0 +1,3 @@
+module Vtex
+  VERSION = "0.1.0"
+end

data/vtex.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vtex/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vtex"
+  spec.version       = Vtex::VERSION
+  spec.authors       = ["Mumo Carlos"]
+  spec.email         = ["mumo.crls@gmail.com"]
+
+  spec.summary       = %q{Gem to wrap VTex API}
+  spec.description   = %q{Gem to wrap VTex API}
+  spec.homepage      = "https://github.com/mumoc/vtex"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'virtus'
+  spec.add_dependency "resource_kit"
+  spec.add_dependency "kartograph"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faraday"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  # FakeServe
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: vtex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mumo Carlos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resource_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kartograph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: sinatra
+  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: webmock
+  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: Gem to wrap VTex API
+email:
+- mumo.crls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vtex.rb
+- lib/vtex/client.rb
+- lib/vtex/mappings/product_mapping.rb
+- lib/vtex/models/base.rb
+- lib/vtex/models/product.rb
+- lib/vtex/resources/product_resource.rb
+- lib/vtex/version.rb
+- vtex.gemspec
+homepage: https://github.com/mumoc/vtex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Gem to wrap VTex API
+test_files: []