neto_api_ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2859d12c142813b8482efb540e8af28914c79683
+  data.tar.gz: 0e1f911dc424eba87e11d30ec60add20d2c9114c
+SHA512:
+  metadata.gz: 3f789ff45240cdbdf66bab69ec1ecb3987cd9831e376fe68e660179d2ab357eb35912988daf306cbfa566c596019c6b9338a19181ca0b8aec1f88cd01029764c
+  data.tar.gz: adf4741f72761505269c65172815b8ed89c99d9483cde269ab8b543fe0edb2f1d1174138601b328312aa4e4a44542da3510828466e38694296984d79b5afb2c4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

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 bono.lau@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 neto_api_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 bono
+
+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,50 @@
+# Neto API in Ruby
+
+A thin Ruby wrapper for connecting to NETO REST API. Easily interact with the NETO API using this library.
+
+## Installation
+
+    $ gem install neto_api_ruby
+
+## Getting started
+
+Generate API credentials (API secure key) following this instructions 
+https://www.neto.com.au/api
+API endpoints, filters and output selector can also be found on the page above.
+
+## Setup
+
+Setup for the new NETO API integration:
+```ruby
+require "neto_api_ruby"
+
+neto = NetoApiRuby::API.new(neto_host_url, api_key)
+```
+
+##Methods
+
+|   Params   |   Type   |                         Description                          | 		Example				 |
+| ---------- | -------- | ------------------------------------------------------------ | --------------------------- |
+| `query`    | `Hash`   | For get products, data field filter should be specified.     | {"InventoryID"=> ["100"]}   |
+|            |          | By default IsActive Filter is specified.                     | 							 |
+
+### get_products
+- `.get_products(query)`
+
+#### Response
+
+All methods will return [HTTParty::Response](https://github.com/jnunemaker/httparty) object.
+
+## Release History
+- 2017-02-08 - 0.0.1 - Beta release. Nothing will be there in the gem until version goes up to 0.1.1
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bonogit/neto_api_ruby. This project is for my own neto integration use. It also 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

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/neto_api_ruby/version.rb

@@ -0,0 +1,3 @@
+module NetoApiRuby
+  VERSION = "0.0.2"
+end

data/lib/neto_api_ruby.rb

@@ -0,0 +1,78 @@
+require "httparty"
+require "json"
+require "neto_api_ruby/version"
+
+module NetoApiRuby
+  class API
+
+  	def initialize url, api_key
+  		#required args
+  		@neto_url = url
+  		#optional args
+  		@header_args ={
+  		  "Accept"      => "application/json",
+  		  "Content-Type"=> "application/json",
+  		  "NETOAPI_KEY" => api_key
+  		}
+  		@body_defaults = {
+		    # "Filter"=> {
+		        "IsActive"=> ["True"],
+		        "OutputSelector"=> [
+		            "ID",
+                "SKU",
+                "ParentSKU",
+                "InventoryID",
+                "Name",
+                "Brand",
+                "Description",
+                "Active",
+                "Visible",
+                "Categories",
+                "RRP",
+                "PromotionPrice",
+                "PriceGroups",
+                "DateAdded",
+                "DateAddedLocal",
+                "DateAddedUTC",
+                "DateUpdated",
+                "DateUpdatedLocal",
+                "DateUpdatedUTC",
+                "Group",
+                "WarehouseQuantity",
+                "TaxInclusive"
+		        ]
+		    # }
+		}
+
+  	end
+  	#public methods
+  	#query    - A Hash with query params, insert into request body
+  	#returns the request Array
+  	def get_products query={} 
+  		do_request :post, 'GetItem', query
+  	end
+
+
+  	protected
+  	#Internal methods: Append data as query params to an endpoint
+
+  	def do_request method, action, query={}
+  	  url = @neto_url
+  	  options = { }
+  	  header_action = {
+  	  	"NETOAPI_ACTION"=> action
+  	  }
+  	  #set headers
+  	  options[:headers] = @header_args.merge(header_action)
+  	  #set body
+  	  if query.empty?
+	  	options.merge!(body: {"Filter"=> @body_defaults}.to_json)
+	  else 
+    	body_args = @body_defaults.merge(query) 
+    	options.merge!(body: {"Filter"=> body_args}.to_json)
+  	  end
+  	  HTTParty.send(method, url, options)
+  	end
+
+  end
+end

data/neto_api_ruby.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubygems'
+require 'neto_api_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "neto_api_ruby"
+  spec.version       = NetoApiRuby::VERSION
+  spec.authors       = ["bono"]
+  spec.email         = ["bono.lau@gmail.com"]
+
+  spec.summary       = "A Ruby wrapper for the NETO API"
+  spec.description   = "This gem provide a wrapper to deal with NETO REST API"
+  spec.homepage      = "https://github.com/bonogit/neto_api_ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+  
+  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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "fakeweb", "~> 1.3.0"
+  spec.add_runtime_dependency "httparty", "~> 0.14", ">= 0.14.0"
+  spec.add_runtime_dependency "json", "~> 2.0.3", ">= 2.0.0"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: neto_api_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- bono
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: This gem provide a wrapper to deal with NETO REST API
+email:
+- bono.lau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/neto_api_ruby.rb
+- lib/neto_api_ruby/version.rb
+- neto_api_ruby-0.0.1.gem
+- neto_api_ruby.gemspec
+homepage: https://github.com/bonogit/neto_api_ruby
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the NETO API
+test_files: []