splynx_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ba0b3eede2ae4ce281d97e848dc098d07dfe6c8
+  data.tar.gz: 24eecb1e9b0525e5f226e5d11d18677c1f41f9a8
+SHA512:
+  metadata.gz: 9ddf0d1157cd961f2339a61ba0540c19e47d066b5c973a3c7733e3fb073fadf2a48860e42090dc7a608ab7e1c2d3ae14a2fd8c2190c6233595730a4112b4e65a
+  data.tar.gz: c665fd970a25d2f1498f0142e4e0e370d8ef35e4c3f70c7926ac8300ff031ebf7005dd6c8aeb41d03f1a2e41bd1a84fb665698b3f046e1940c90135e37a0dd34

data/.gitignore

@@ -0,0 +1,26 @@
+.DS_Store
+*.gem
+*.rbc
+*.sassc
+.bundle
+.config
+.yardoc
+.rvmrc
+.rspec
+.sass-cache
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+doc/
+coverage
+lib/bundler/man
+capybara-*.html
+pkg
+rdoc
+spec/reports
+spec/tmp
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in splynx_api.gemspec
+gemspec
+
+gem 'rest-client'
+gem 'openssl'
+gem 'php_http_build_query'

data/README.md

@@ -0,0 +1,149 @@
+# SplynxApi
+
+A simple helper for [Splynx API](http://docs.splynx.apiary.io/) based on [REST Client](https://github.com/rest-client/rest-client).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'splynx_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install splynx_api
+
+## Usage
+Get your API data from <Your splynx url>/admin/administration/api-keys. Before use the API please check your api permissions.
+
+```ruby
+require 'splynx_api'
+
+api = SplynxApi::Api.new({
+  :base_url => '<protocol>://<domain>',
+  :key => 'Your Splynx Api key',
+  :secret => 'Your Splynx Api secret',
+  :verify_ssl => false
+})
+
+# Get list of all locations
+response = api.get('/admin/administration/locations')
+
+puts response.code
+puts response.body
+```
+
+## SplynxApi::Api reference
+
+### new(params)
+* :base_url - Splynx url with protocol
+* :key - Splynx Api key
+* :secret - Splynx Api secret
+* :verify_ssl - Enable verify ssl (Default: true)
+
+Create new instance of Api
+
+### get(uri, id)
+* uri - Required
+* id - Optional
+
+Get list of models. Optionally, an id may be provided to retrieve one a model.
+
+Returned RestClient::Response or error object.
+
+### post(uri, params)
+* uri - Required
+* params - Required
+
+Create new model with provided attributes value.
+Returned RestClient::Response or error object.
+
+Example:
+```ruby
+# Create new location named "My Location"
+response = api.post('/admin/administration/locations', {
+  'name' => 'My Location'
+})
+```
+
+### put(uri, id, params)
+* uri - Required
+* id - Required
+* params - Required
+
+Update existing model.
+
+Returned RestClient::Response or error object.
+
+Example:
+```ruby
+# Rename location with id 1 to "Updated Location"
+response = api.put('/admin/administration/locations', 1, {
+  'name' => 'My Location'
+})
+```
+
+### search(uri, params)
+* uri - Required
+* params - Required
+
+Search model by custom parameters.
+
+Returned RestClient::Response or error object.
+
+Example:
+```ruby
+# Search location with name "Updated Location"
+response = api.search('/admin/administration/locations', {
+  'main_attributes' => {
+    'name' => 'Updated Location'
+  }
+})
+```
+
+### delete(uri, id)
+* uri - Required
+* id - Required
+
+Delete model by id.
+
+Returned RestClient::Response or error object.
+
+Example:
+```ruby
+# Delete location with id 1
+response = api.delete('/admin/administration/locations', 1)
+```
+
+### How to get administrator information
+Set session hash property for get administrator information in next request.
+
+Example:
+```ruby
+api.sash = 'Your session hash'
+api.get('/admin/customers/customer')
+
+puts api.administrator
+
+# Returned:
+#{
+#  :id => 'Admin ID',
+#  :role => 'Admin role',
+#  :partner => 'Admin partner ID'
+#}
+``` 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/splynx/splynx-ruby-api.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

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

@@ -0,0 +1,3 @@
+module SplynxApi
+  VERSION = '0.1.0'
+end

data/lib/splynx_api.rb

@@ -0,0 +1,112 @@
+require 'splynx_api/version'
+require 'openssl'
+require 'cgi'
+require 'rest-client'
+require 'php_http_build_query'
+
+module SplynxApi
+  class Api
+    attr_accessor :sash
+
+    def initialize(params)
+      @base_url = params[:base_url]
+      @key = params[:key]
+      @secret = params[:secret]
+      @verify_ssl = params[:verify_ssl].nil? ? true : params[:verify_ssl]
+      @version = '1.0'
+      @nonce_v = Time.now.to_i
+      @sash = nil
+      @administrator = nil
+    end
+
+    def administrator
+      @administrator
+    end
+
+    def signature
+      str = "#{@nonce_v}#{@key}"
+      digest = OpenSSL::Digest::SHA256.new
+      OpenSSL::HMAC.hexdigest(digest, @secret, str).upcase
+    end
+
+    def auth
+      auth = {
+          :nonce => @nonce_v,
+          :key => @key,
+          :signature => signature
+      }
+      unless @sash.nil?
+        auth[:sash] = @sash
+      end
+
+      @nonce_v = @nonce_v + 1
+
+      PHP.http_build_query(auth)
+    end
+
+    def url(uri, id = nil, params = nil)
+      result = "#{@base_url}/api/#{@version}#{uri}"
+
+      unless id.nil?
+        result = "#{result}/#{id}"
+      end
+      unless params.nil?
+        params_string = PHP.http_build_query(params)
+        result = "#{result}?#{params_string}"
+      end
+
+      result
+    end
+
+    def process_response(response)
+      headers = response.headers
+      unless headers[:spl_administrator_id].nil?
+        @administrator = {
+            :id => headers[:spl_administrator_id],
+            :role => headers[:spl_administrator_role],
+            :partner => headers[:spl_administrator_partner]
+        }
+      end
+      response
+    end
+
+    def perform(method, url, params = nil)
+      begin
+        response = RestClient::Request.execute(
+            method: method,
+            url: url,
+            verify_ssl: @verify_ssl,
+            payload: params,
+            headers: {
+                :Authorization => "Splynx-EA (#{auth})",
+                :user_agent => "Splynx Ruby API #{@version}"
+            })
+        process_response(response)
+      rescue StandardError => e
+        e
+      end
+    end
+
+    def get(uri, id = nil)
+      perform(:get, url(uri, id))
+    end
+
+    def post(uri, params)
+      perform(:post, url(uri), params)
+    end
+
+    def delete(uri, id)
+      perform(:delete, url(uri, id))
+    end
+
+    def put(uri, id, params)
+      perform(:put, url(uri, id), params)
+    end
+
+    def search(uri, params)
+      perform(:get, url(uri, nil, params))
+    end
+
+    protected :signature, :auth, :url, :perform, :process_response
+  end
+end

data/splynx_api.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'splynx_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'splynx_api'
+  spec.version       = SplynxApi::VERSION
+  spec.authors       = ['Tsumanchuk Volodymyr']
+  spec.email         = ['buorn2011@gmail.com']
+
+  spec.summary       = %q{Splynx API}
+  spec.description   = %q{Module for Splynx API}
+  spec.homepage      = 'https://bitbucket.org/splynx/splynx-ruby-api'
+
+  # 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'] = ''
+  # 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.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'rest-client', '~> 2.0.2'
+  spec.add_dependency 'openssl', '~> 2.0.5'
+  spec.add_dependency 'php_http_build_query', '~> 0.1'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: splynx_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tsumanchuk Volodymyr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-23 00:00:00.000000000 Z
+dependencies:
+- !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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: php_http_build_query
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Module for Splynx API
+email:
+- buorn2011@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/setup
+- lib/splynx_api.rb
+- lib/splynx_api/version.rb
+- splynx_api.gemspec
+homepage: https://bitbucket.org/splynx/splynx-ruby-api
+licenses: []
+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.13
+signing_key: 
+specification_version: 4
+summary: Splynx API
+test_files: []