plenty_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df01cb8f8df7f62a1a367ae679ef7326c7d861d6
+  data.tar.gz: 1fb7060354dec458e6ebb1a70e9e7d3345fee8ce
+SHA512:
+  metadata.gz: 52ff8c31d2ba058e438c06aad948c56516abd8a50fb153b78ad34749636ebe8aa56684c321364b83e2ac1503be84a2c41334a449a95c1e267c86ba5d93fb0316
+  data.tar.gz: 261c38a16937ad2e2a7f3100c132a155d1d7ed7509386f4921ac12dee9769dbb15cc54ad02dd0d2ddc88a836f49a19c8d6f8cd495b0a810f64acbc10d3e1819a

data/.gitignore

@@ -0,0 +1,23 @@
+Gemfile.lock
+
+*.gem
+
+.DS_Store
+.bundle
+.rvmrc
+.rbenv-version
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+bin/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+# This is the configuration used to check the rubocop source code.
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'db/schema.rb'
+Lint/HandleExceptions:
+  Exclude:
+    - 'bin/console'
+    - 'bin/eun'
+    - 'bin/setup'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Encoding:
+  Enabled: true
+Style/NumericLiterals:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: true
+  MinBodyLength: 1
+
+Metrics/LineLength:
+  Max: 120
+Metrics/AbcSize:
+  Max: 999
+Metrics/ClassLength:
+  Max: 999
+Metrics/CyclomaticComplexity:
+  Max: 99
+Metrics/MethodLength:
+  Max: 999
+Metrics/ModuleLength:
+  Max: 999
+Metrics/ParameterLists:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 99

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dariusch.ochlast@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plenty_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dariusch Ochlast
+
+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,154 @@
+# PlentyClient
+[![Code Climate](https://codeclimate.com/github/Dariusch/plenty_client/badges/gpa.svg)](https://codeclimate.com/github/Dariusch/plenty_client)
+[![Issue Count](https://codeclimate.com/github/Dariusch/plenty_client/badges/issue_count.svg)](https://codeclimate.com/github/Dariusch/plenty_client)
+[![Test Coverage](https://codeclimate.com/github/Dariusch/plenty_client/badges/coverage.svg)](https://codeclimate.com/github/Dariusch/plenty_client/coverage)
+[![Build Status](https://travis-ci.org/Dariusch/plenty_client.svg?branch=master)](https://travis-ci.org/Dariusch/plenty_client)
+
+This Client is a ruby wrapper around the PlentyMarkets REST API.  
+The complete documentation can be found [here](https://developers.plentymarkets.com/rest-doc).  
+
+## Installation
+
+Add this line to your application's Gemfile:
+```
+gem 'plenty_client'
+```
+
+And then execute:
+```ruby
+bundle install
+```
+
+Or install it yourself as:
+```ruby
+gem install plenty_client
+```
+
+## Getting Started
+
+### Configuration
+PlentyClient is a simple Ruby library. It works with Rails, as well as in a simple irb.
+Make sure you configure the PlentyClient with the following options:
+
+```ruby
+PlentyClient::Config.site_url     = 'http://plenty7.plentymarkets.de/rest'
+PlentyClient::Config.api_user     = 'myusername'
+PlentyClient::Config.api_password = 'mypassword'
+PlentyClient::Config.log          = true || false
+```
+
+# Calls
+Once you are set up you can use the client with the following methods:  
+
+Note:
+  - required parameters need to be passed in, otherwise you will get an error
+  - This Client handles no validation, it is only a gateway to the API
+
+```ruby
+PlentyClient::Item.find(103)
+PlentyClient::Item::Variation.find(103, 105)
+
+PlentyClient::Item.list
+PlentyClient::Item::Variation.list
+
+PlentyClient::Item.create(parameters)
+
+PlentyClient::Item::Variation.update(103, update_parameters)
+
+PlentyClient::Item::Variation.delete(103, 105)
+
+```
+
+### Blocks
+
+```ruby
+# Use blocks to iterate in batches
+PlentyClient::Item.list do |item|
+  puts item
+end
+
+# You can set optional headers after the required parameters of each request
+PlentyClient::Item::Variation.list(103, {'itemsPerPage' => 1, 'page' => 4}) do |item|
+  puts item
+end
+```
+
+### HTTP-Methods
+
+If there is no resource available you can still make the request like so:
+```ruby
+PlentyClient::Request.patch(path, body = {})
+PlentyClient::Request.put(path, body = {})
+PlentyClient::Request.post(path, body = {})
+PlentyClient::Request.delete(path, params = {})
+PlentyClient::Request.get(path, params = {})
+PlentyClient::Request.get(path, params = {}) do |body|
+end
+```
+
+### Warnings
+There is a difference in the get method with and without a block.
+This returns the raw body with all parameters
+
+```ruby
+PlentyClient::Request.get(path, params = {})
+
+```
+The get-call with the block only returns the entries
+```ruby
+PlentyClient::Request.get(path, params = {}) do |body|
+  puts entries
+end
+
+```
+
+### Debugging
+If you are not sure which required parameters to pass in simply call
+
+```ruby
+PlentyClient::Item::Variation.routes
+```
+
+## Todo:
+
+- write some specs
+- clean up `plenty_client/request.rb`
+* create classes for
+  * [`Account`](https://developers.plentymarkets.com/rest-doc/account)
+  * [`Accounting`](https://developers.plentymarkets.com/rest-doc/accounting)
+  * [`Authentication`](https://developers.plentymarkets.com/rest-doc/authentication)
+  * [`Authorization`](https://developers.plentymarkets.com/rest-doc/authorization)
+  * [`Basket`](https://developers.plentymarkets.com/rest-doc/basket)
+  * [`Category`](https://developers.plentymarkets.com/rest-doc/category)
+  * [`Cloud`](https://developers.plentymarkets.com/rest-doc/cloud)
+  * [`Comment`](https://developers.plentymarkets.com/rest-doc/comment)
+  * [`Document`](https://developers.plentymarkets.com/rest-doc/document)
+  * [`Export`](https://developers.plentymarkets.com/rest-doc/export)
+  * [`ExportSettings`](https://developers.plentymarkets.com/rest-doc/export_settings)
+  * [~~`Item`~~](https://developers.plentymarkets.com/rest-doc/item)
+  * [`LegalInformation`](https://developers.plentymarkets.com/rest-doc/legal_information)
+  * [`Market`](https://developers.plentymarkets.com/rest-doc/market)
+  * [~~`Order`~~](https://developers.plentymarkets.com/rest-doc/order)
+  * [`OrderSummary`](https://developers.plentymarkets.com/rest-doc/order_summary)
+  * [`Payment`](https://developers.plentymarkets.com/rest-doc/payment)
+  * [`Plugins`](https://developers.plentymarkets.com/rest-doc/plugins)
+  * [`StockManagement`](https://developers.plentymarkets.com/rest-doc/stock_management)
+  * [`Ticket`](https://developers.plentymarkets.com/rest-doc/ticket)
+  * [`Webstore`](https://developers.plentymarkets.com/rest-doc/webstore)
+- missing [OrderItem OrderItemDate](https://developers.plentymarkets.com/rest-doc/order_order_item_order_item_date/details#get-all-order-item-dates-for-one-order-item-by-its-order-item-id) - its just a mess
+- missing [OrderProperty](https://developers.plentymarkets.com/rest-doc/order#rest-orderproperty) - its just a mess
+- missing [OrderItem OrderItemProperty ](https://developers.plentymarkets.com/rest-doc/order_order_item_order_item_property/details#get-all-order-item-propertys-for-one-order-item-by-its-order-item-id) - its just a mess
+- update all modules to classes and make it inherit from a base class to remove `extend PlentyClient::Request` etc
+- create a configure block to set authentication parameters
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+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).
+

data/Rakefile

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

data/lib/plenty_client/config.rb

@@ -0,0 +1,15 @@
+module PlentyClient
+  class Config
+    class NoCredentials < StandardError; end
+    class NoToken < StandardError; end
+
+    class << self
+      attr_accessor :site_url, :api_user, :api_password, :access_token, :refresh_token, :log
+
+      def validate
+        raise NoCredentials if site_url.nil? || api_user.nil? || api_password.nil?
+        raise NoToken if access_token.nil? || refresh_token.nil?
+      end
+    end
+  end
+end