beanie 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9d7c840623b52dd7d260c2615d6babc9430a5131
-  data.tar.gz: 96a50d8e6b87df0f975f8402f52066681fdc63d8
+SHA256:
+  metadata.gz: a07e34c438286e63a9e4491ba6a9aed8aed2505f72fe8e20547aa789798e74b1
+  data.tar.gz: 0d17a5663f2766aee6b254539cf208e024fc14b8b2e272164280db3d0645d2d5
 SHA512:
-  metadata.gz: 175c1fa9545cc1207d9fe7b40ff691a834265407780d0b99118b697b262667b922f96cd123c2709c5cadf7b1438268eac53435b9daae3c4037a86ee4c61e07cc
-  data.tar.gz: cb9056698787ee4df3710b07fa9eff507168e9a1667a81840657ae43be7c114f2eeed38624ff1c4762378bd018d7437cc9606f89c07e5eb1a9ce8cd2db8dc0ba
+  metadata.gz: 1d340473109a96b5035f13254b658ce928237d64fed5b23e7200a8455c840330ec98216d3284c543c0566f787d86adac252a037bf32e3c1b770784aa39c8489f
+  data.tar.gz: 0a990bc0f501b277d298e366dc7c7adc11fcf927e8579f4ac6aa48d05aaeee534df4376e6c193432afe286eb8932c3998eceefffcceb19b40522711128b76d0a

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -1,29 +1,92 @@
-# Beanie API Bindings
+# beanie
 
-This gem provides an API interface into the Beanie cloud-based ERP system.
+Beanie - the Ruby gem for the Beanie ERP API
+
+An API specification for interacting with the Beanie ERP system
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 0.1
+- Package version: 0.2.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build beanie.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./beanie-0.2.0.gem
+```
+(for development, run `gem install --dev ./beanie-0.2.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'beanie', '~> 0.2.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/altoyield/ruby-beanieclient, then add the following in the Gemfile:
+
+    gem 'beanie', :git => 'https://github.com/altoyield/ruby-beanieclient.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'beanie'
+
+api_instance = Beanie::BankAccountApi.new
+
+bank_account = Beanie::BankAccountInput.new # BankAccountInput | Bank account to add to the system
+
+
+begin
+  result = api_instance.add_bank_account(bank_account)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling BankAccountApi->add_bank_account: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
 
-    gem 'beanie'
+All URIs are relative to *https://bean.ie*
 
-And then execute:
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Beanie::BankAccountApi* | [**add_bank_account**](docs/BankAccountApi.md#add_bank_account) | **POST** /bank_accounts | 
+*Beanie::BankAccountApi* | [**find_bank_account_by_id**](docs/BankAccountApi.md#find_bank_account_by_id) | **GET** /bank_accounts/{id} | Find Bank Account by ID
+*Beanie::BankAccountApi* | [**find_bank_accounts**](docs/BankAccountApi.md#find_bank_accounts) | **GET** /bank_accounts | All bank accounts
 
-    $ bundle
 
-Or install it yourself as:
+## Documentation for Models
 
-    $ gem install beanie
+ - [Beanie::BankAccount](docs/BankAccount.md)
+ - [Beanie::ErrorModel](docs/ErrorModel.md)
+ - [Beanie::BankAccountInput](docs/BankAccountInput.md)
 
-## Usage
 
-TODO: Write usage instructions here
+## Documentation for Authorization
 
-## Contributing
+ All endpoints do not require authorization.
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/beanie.gemspec

@@ -1,26 +1,45 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'beanie/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "beanie"
-  spec.version       = Beanie::VERSION
-  spec.authors       = ["Dermot Tynan"]
-  spec.email         = ["dtynan@kalopa.com"]
-  spec.summary       = %q{Ruby bindings for the Beanie API}
-  spec.description   = %q{Beanie - Your Cloud-Based ERP System. See https://bean.ie for more details.}
-  spec.homepage      = "https://bean.ie/help/api/ruby"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.0"
-
-  spec.add_dependency 'rest-client', "~> 2.0"
-  spec.add_dependency 'json'
+# -*- encoding: utf-8 -*-
+
+=begin
+#Beanie ERP API
+
+#An API specification for interacting with the Beanie ERP system
+
+OpenAPI spec version: 0.1
+Contact: dev@bean.ie
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "beanie/version"
+
+Gem::Specification.new do |s|
+  s.name        = "beanie"
+  s.version     = Beanie::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Beanie Development Team"]
+  s.email       = ["dev@bean.ie"]
+  s.homepage    = "https://rubygems.org/gems/beanie"
+  s.summary     = "Beanie ERP API Ruby Gem"
+  s.description = "An API specification for interacting with the Beanie ERP system"
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
 end

data/docs/BankAccount.md

@@ -0,0 +1,24 @@
+# Beanie::BankAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**name** | **String** |  | 
+**bank_name** | **String** |  | 
+**currency** | **String** |  | 
+**swift** | **String** |  | 
+**iban** | **String** |  | 
+**address1** | **String** |  | [optional] 
+**address2** | **String** |  | [optional] 
+**address3** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**state_county** | **String** |  | [optional] 
+**zip_postcode** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+**contact_name** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**website** | **String** |  | [optional] 
+
+

data/docs/BankAccountApi.md

@@ -0,0 +1,154 @@
+# Beanie::BankAccountApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_bank_account**](BankAccountApi.md#add_bank_account) | **POST** /bank_accounts | 
+[**find_bank_account_by_id**](BankAccountApi.md#find_bank_account_by_id) | **GET** /bank_accounts/{id} | Find Bank Account by ID
+[**find_bank_accounts**](BankAccountApi.md#find_bank_accounts) | **GET** /bank_accounts | All bank accounts
+
+
+# **add_bank_account**
+> BankAccount add_bank_account(bank_account)
+
+
+
+Creates a new bank account in the system
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+
+api_instance = Beanie::BankAccountApi.new
+
+bank_account = Beanie::BankAccountInput.new # BankAccountInput | Bank account to add to the system
+
+
+begin
+  result = api_instance.add_bank_account(bank_account)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling BankAccountApi->add_bank_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **bank_account** | [**BankAccountInput**](BankAccountInput.md)| Bank account to add to the system | 
+
+### Return type
+
+[**BankAccount**](BankAccount.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_bank_account_by_id**
+> BankAccount find_bank_account_by_id(id)
+
+Find Bank Account by ID
+
+Returns a single bank account if the user has access
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+
+api_instance = Beanie::BankAccountApi.new
+
+id = 789 # Integer | ID of bank account to fetch
+
+
+begin
+  #Find Bank Account by ID
+  result = api_instance.find_bank_account_by_id(id)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling BankAccountApi->find_bank_account_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of bank account to fetch | 
+
+### Return type
+
+[**BankAccount**](BankAccount.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_bank_accounts**
+> Array<BankAccount> find_bank_accounts(opts)
+
+All bank accounts
+
+Returns all bank accounts from the system that the user has access to
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+
+api_instance = Beanie::BankAccountApi.new
+
+opts = { 
+  tags: ['tags_example'], # Array<String> | tags to filter by
+  limit: 56 # Integer | maximum number of results to return
+}
+
+begin
+  #All bank accounts
+  result = api_instance.find_bank_accounts(opts)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling BankAccountApi->find_bank_accounts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tags** | [**Array&lt;String&gt;**](String.md)| tags to filter by | [optional] 
+ **limit** | **Integer**| maximum number of results to return | [optional] 
+
+### Return type
+
+[**Array&lt;BankAccount&gt;**](BankAccount.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/BankAccountInput.md

@@ -0,0 +1,24 @@
+# Beanie::BankAccountInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**name** | **String** |  | 
+**bank_name** | **String** |  | 
+**currency** | **String** |  | 
+**swift** | **String** |  | 
+**iban** | **String** |  | 
+**address1** | **String** |  | [optional] 
+**address2** | **String** |  | [optional] 
+**address3** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**state_county** | **String** |  | [optional] 
+**zip_postcode** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+**contact_name** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**website** | **String** |  | [optional] 
+
+

data/docs/ErrorModel.md

@@ -0,0 +1,9 @@
+# Beanie::ErrorModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** |  | 
+**message** | **String** |  | 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="altoyield"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="ruby-beanieclient"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/beanie/api/bank_account_api.rb

@@ -0,0 +1,183 @@
+=begin
+#Beanie ERP API
+
+#An API specification for interacting with the Beanie ERP system
+
+OpenAPI spec version: 0.1
+Contact: dev@bean.ie
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module Beanie
+  class BankAccountApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Creates a new bank account in the system
+    # @param bank_account Bank account to add to the system
+    # @param [Hash] opts the optional parameters
+    # @return [BankAccount]
+    def add_bank_account(bank_account, opts = {})
+      data, _status_code, _headers = add_bank_account_with_http_info(bank_account, opts)
+      data
+    end
+
+    # Creates a new bank account in the system
+    # @param bank_account Bank account to add to the system
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BankAccount, Fixnum, Hash)>] BankAccount data, response status code and response headers
+    def add_bank_account_with_http_info(bank_account, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BankAccountApi.add_bank_account ...'
+      end
+      # verify the required parameter 'bank_account' is set
+      if @api_client.config.client_side_validation && bank_account.nil?
+        fail ArgumentError, "Missing the required parameter 'bank_account' when calling BankAccountApi.add_bank_account"
+      end
+      # resource path
+      local_var_path = '/bank_accounts'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(bank_account)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'BankAccount')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BankAccountApi#add_bank_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Find Bank Account by ID
+    # Returns a single bank account if the user has access
+    # @param id ID of bank account to fetch
+    # @param [Hash] opts the optional parameters
+    # @return [BankAccount]
+    def find_bank_account_by_id(id, opts = {})
+      data, _status_code, _headers = find_bank_account_by_id_with_http_info(id, opts)
+      data
+    end
+
+    # Find Bank Account by ID
+    # Returns a single bank account if the user has access
+    # @param id ID of bank account to fetch
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BankAccount, Fixnum, Hash)>] BankAccount data, response status code and response headers
+    def find_bank_account_by_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BankAccountApi.find_bank_account_by_id ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BankAccountApi.find_bank_account_by_id"
+      end
+      # resource path
+      local_var_path = '/bank_accounts/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'BankAccount')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BankAccountApi#find_bank_account_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # All bank accounts
+    # Returns all bank accounts from the system that the user has access to
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :tags tags to filter by
+    # @option opts [Integer] :limit maximum number of results to return
+    # @return [Array<BankAccount>]
+    def find_bank_accounts(opts = {})
+      data, _status_code, _headers = find_bank_accounts_with_http_info(opts)
+      data
+    end
+
+    # All bank accounts
+    # Returns all bank accounts from the system that the user has access to
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :tags tags to filter by
+    # @option opts [Integer] :limit maximum number of results to return
+    # @return [Array<(Array<BankAccount>, Fixnum, Hash)>] Array<BankAccount> data, response status code and response headers
+    def find_bank_accounts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BankAccountApi.find_bank_accounts ...'
+      end
+      # resource path
+      local_var_path = '/bank_accounts'
+
+      # query parameters
+      query_params = {}
+      query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<BankAccount>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BankAccountApi#find_bank_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end