noths 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3c3f937a5855841321a0412e343360b7b5dad2f926a214c53263dd66299d6a6
+  data.tar.gz: 9609210479ca80d88dfee765e3074170046d280c85c56123d5523c68c01e2c3e
+SHA512:
+  metadata.gz: 29968d9dc3873ccaab3ef1d122d029520371806db69e3a0bd49b04c9870cac4daa5dac2d9e3173075668f2dab44feb02ea3383e94f7db13c7e662d519e366ff6
+  data.tar.gz: f09e08acfb0a6e4f17562cc91dc41fc1b6fad7c3c333be1099337d393ab24165b9838ce0a76a7cfc7977caf8c4939c0976ad958a0a703471defded37be383da2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    noths (0.1.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.13)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    public_suffix (3.0.2)
+    rake (12.0.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  noths!
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,149 @@
+# noths
+
+Noths - the Ruby gem for the Noths
+
+www.notonthehighstreet.com API client
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0
+- Package version: 0.1.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build noths.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./noths-0.1.0.gem
+```
+(for development, run `gem install --dev ./noths-0.1.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 'noths', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/veeqo/noths, then add the following in the Gemfile:
+
+    gem 'noths', :git => 'https://github.com/veeqo/noths.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 'noths'
+
+# Setup authorization
+Noths.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['token'] = 'Bearer'
+end
+
+api_instance = Noths::OrdersApi.new
+
+id = 56 # Integer | Order id
+
+estimated_delivery_date = Date.parse("2013-10-20") # Date | 'yyyy-mm-dd'
+
+estimated_dispatch_at = Date.parse("2013-10-20") # Date | 'yyyy-mm-dd'
+
+opts = { 
+  confirmation_note: "confirmation_note_example" # String | 
+}
+
+begin
+  #Accept an order
+  api_instance.orders_acceptance(id, estimated_delivery_date, estimated_dispatch_at, opts)
+rescue Noths::ApiError => e
+  puts "Exception when calling OrdersApi->orders_acceptance: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Noths::OrdersApi* | [**orders_acceptance**](docs/OrdersApi.md#orders_acceptance) | **POST** /api/v1/orders/{id}/accept | Accept an order
+*Noths::OrdersApi* | [**orders_acceptance_bulk**](docs/OrdersApi.md#orders_acceptance_bulk) | **POST** /api/v1/orders/accept | Accept multiple orders
+*Noths::OrdersApi* | [**orders_decline**](docs/OrdersApi.md#orders_decline) | **POST** /api/v1/orders/{id}/decline | Decline an order
+*Noths::OrdersApi* | [**orders_decline_bulk**](docs/OrdersApi.md#orders_decline_bulk) | **POST** /api/v1/orders/decline | Decline multiple orders
+*Noths::OrdersApi* | [**orders_dispatch_note**](docs/OrdersApi.md#orders_dispatch_note) | **GET** /api/v1/orders/{id}/dispatch_note | Generate a dispatch note pdf or gift note pdf.
+*Noths::OrdersApi* | [**orders_dispatch_notes_bulk**](docs/OrdersApi.md#orders_dispatch_notes_bulk) | **POST** /api/v1/orders/dispatch_notes | Generate pdf with dispatch note for each order
+*Noths::OrdersApi* | [**orders_dispatch_order**](docs/OrdersApi.md#orders_dispatch_order) | **POST** /api/v1/orders/{id}/dispatch | Dispatch an order
+*Noths::OrdersApi* | [**orders_dispatch_orders_bulk**](docs/OrdersApi.md#orders_dispatch_orders_bulk) | **POST** /api/v1/orders/dispatch | Dispatch multiple orders
+*Noths::OrdersApi* | [**orders_index**](docs/OrdersApi.md#orders_index) | **GET** /api/v1/orders | Fetch orders
+*Noths::OrdersApi* | [**orders_invoice**](docs/OrdersApi.md#orders_invoice) | **GET** /api/v1/orders/{id}/invoice | Generate a vat invoice pdf.
+*Noths::OrdersApi* | [**orders_order_details**](docs/OrdersApi.md#orders_order_details) | **GET** /api/v1/orders/{id}/order_details | Generate an order details pdf
+*Noths::OrdersApi* | [**orders_order_details_bulk**](docs/OrdersApi.md#orders_order_details_bulk) | **POST** /api/v1/orders/order_details | Generate pdf with order details for each order
+*Noths::OrdersApi* | [**orders_show**](docs/OrdersApi.md#orders_show) | **GET** /api/v1/orders/{id} | Fetch a single Order
+*Noths::RefundsApi* | [**refunds_create**](docs/RefundsApi.md#refunds_create) | **POST** /api/v1/orders/{order_id}/refunds | Refund an order
+
+
+## Documentation for Models
+
+ - [Noths::AcceptanceBulkModel](docs/AcceptanceBulkModel.md)
+ - [Noths::Currency](docs/Currency.md)
+ - [Noths::DeclineBulkModel](docs/DeclineBulkModel.md)
+ - [Noths::DeliveryAddress](docs/DeliveryAddress.md)
+ - [Noths::DeliveryService](docs/DeliveryService.md)
+ - [Noths::DeliveryZone](docs/DeliveryZone.md)
+ - [Noths::DispatchBulkModel](docs/DispatchBulkModel.md)
+ - [Noths::DispatchNotesBulkModel](docs/DispatchNotesBulkModel.md)
+ - [Noths::Enquiry](docs/Enquiry.md)
+ - [Noths::EnquiryMessage](docs/EnquiryMessage.md)
+ - [Noths::Error](docs/Error.md)
+ - [Noths::Financials](docs/Financials.md)
+ - [Noths::FinancialsDetails](docs/FinancialsDetails.md)
+ - [Noths::ImageUrl](docs/ImageUrl.md)
+ - [Noths::Item](docs/Item.md)
+ - [Noths::ItemFinancials](docs/ItemFinancials.md)
+ - [Noths::Link](docs/Link.md)
+ - [Noths::ManualPayment](docs/ManualPayment.md)
+ - [Noths::Money](docs/Money.md)
+ - [Noths::Order](docs/Order.md)
+ - [Noths::OrderDetail](docs/OrderDetail.md)
+ - [Noths::OrderDetailsBulkModel](docs/OrderDetailsBulkModel.md)
+ - [Noths::OrderIndex](docs/OrderIndex.md)
+ - [Noths::OrderRefund](docs/OrderRefund.md)
+ - [Noths::Product](docs/Product.md)
+ - [Noths::ProductOption](docs/ProductOption.md)
+ - [Noths::RefundResponse](docs/RefundResponse.md)
+ - [Noths::SearchResultMeta](docs/SearchResultMeta.md)
+ - [Noths::User](docs/User.md)
+
+
+## Documentation for Authorization
+
+
+### token
+
+- **Type**: API key
+- **API key parameter name**: token
+- **Location**: URL query string
+

data/Rakefile

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

data/bin/generate_gem

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+gem_dir         = File.expand_path('../', __dir__)
+config_path     = File.expand_path('../swagger_config.json', __dir__)
+api_schema_path = File.expand_path('../schemas/api-docs.json', __dir__)
+
+default_generator_options = {
+  '-l' => 'ruby',
+  '-i' => api_schema_path,
+  '-o' => gem_dir,
+  '-c' => config_path
+}
+
+generator_options = default_generator_options.merge(Hash[*ARGV])
+                                             .map { |node| node.join(' ') }
+                                             .join(' ')
+
+system "swagger-codegen generate #{generator_options}"

data/bin/refresh_schemas

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+require 'net/http'
+require 'json'
+
+api_docs_uri = URI('https://api.notonthehighstreet.com/doc-1.0/api-docs.json')
+
+schemas_dir = File.expand_path('../schemas', __dir__)
+
+def fetch_json(uri)
+  res = Net::HTTP.start(uri.hostname,
+                        uri.port,
+                        use_ssl: uri.scheme == 'https') do |http|
+    http.request(Net::HTTP::Get.new(uri))
+  end
+
+  res.error! unless res.is_a?(Net::HTTPSuccess)
+
+  JSON.parse(res.body, symbolize_names: true)
+end
+
+# Fix original schema invalid directives
+def apply_ammendments(api_schema)
+  api_schema.fetch(:apis).each do |endpoint|
+    endpoint.fetch(:operations).each do |method|
+      method[:nickname] = method[:nickname].sub('Api::V1::', '') unless method[:nickname].nil?
+
+      token_parameter = method[:parameters].detect { |p| p[:name] == 'token' }
+
+      if token_parameter
+        method[:authorizations] ||= { token: [] }
+        method[:parameters].delete(token_parameter)
+      end
+
+      method[:parameters].each do |p|
+        p[:required] = true if p[:required] == 'required'
+
+        case p[:type]
+        when 'date'
+          p[:type]    = 'string'
+          p[:format]  = 'date'
+        when 'datetime'
+          p[:type]    = 'string'
+          p[:format]  = 'date-time'
+        end
+
+        p[:name] = :payload if p[:paramType] == 'body' && p[:name] == ''
+      end
+    end
+  end
+
+  api_schema.fetch(:models).values.each do |model|
+    model.fetch(:properties).values.each do |p|
+      p[:type] = p[:items][:'$ref'] if p[:type] == 'complex'
+    end
+  end
+end
+
+main_schema = fetch_json(api_docs_uri)
+
+main_schema.fetch(:apis).each do |api|
+  api_path = api.fetch(:path).sub('.{format}', '.json')
+
+  api_uri = api_docs_uri.dup
+
+  api_uri.path = ['/', api_path].join
+
+  api[:path] = File.basename(api_path) # making path relative to schema file
+
+  File.open [schemas_dir, File.basename(api_uri.path)].join('/'), 'w' do |io|
+    api_schema = fetch_json(api_uri)
+
+    apply_ammendments(api_schema) unless ARGV.include?('--skip-amendments')
+
+    io.write JSON.pretty_generate(api_schema)
+  end
+end
+
+main_schema[:info] ||= {
+  title: 'Noths',
+  description: 'www.notonthehighstreet.com API client'
+}
+
+main_schema[:authorizations] ||= {
+  token: {
+    'type':     'apiKey',
+    'passAs':   'query',
+    'keyname':  'token'
+  }
+}
+
+File.open [schemas_dir, File.basename(api_docs_uri.path)].join('/'), 'w' do |io|
+  io.write JSON.pretty_generate(main_schema)
+end

data/docs/AcceptanceBulkModel.md

@@ -0,0 +1,11 @@
+# Noths::AcceptanceBulkModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Order Id | 
+**estimated_delivery_date** | **Date** | 'yyyy-mm-dd' | 
+**estimated_dispatch_at** | **Date** | 'yyyy-mm-dd' | 
+**confirmation_note** | **String** |  | [optional] 
+
+

data/docs/Currency.md

@@ -0,0 +1,11 @@
+# Noths::Currency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subunit_to_unit** | **Integer** |  | 
+**symbol** | **String** |  | 
+**html_entity** | **String** |  | 
+**iso_code** | **String** |  | 
+
+

data/docs/DeclineBulkModel.md

@@ -0,0 +1,9 @@
+# Noths::DeclineBulkModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Order Id | 
+**decline_reason** | **String** |  | 
+
+

data/docs/DeliveryAddress.md

@@ -0,0 +1,13 @@
+# Noths::DeliveryAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address1** | **String** |  | 
+**address2** | **String** |  | 
+**town** | **String** |  | 
+**post_code** | **String** |  | 
+**country** | **String** |  | 
+**county** | **String** |  | 
+
+

data/docs/DeliveryService.md

@@ -0,0 +1,9 @@
+# Noths::DeliveryService
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**code** | **String** |  | 
+
+

data/docs/DeliveryZone.md

@@ -0,0 +1,9 @@
+# Noths::DeliveryZone
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**name** | **String** |  | 
+
+

data/docs/DispatchBulkModel.md

@@ -0,0 +1,12 @@
+# Noths::DispatchBulkModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Order Id | 
+**estimated_delivery_date** | **Date** | 'yyyy-mm-dd' | 
+**resolve_enquiry** | **BOOLEAN** |  | [optional] 
+**tracking_number** | **String** |  | [optional] 
+**parcel_tracking_url** | **String** |  | [optional] 
+
+