bliss-client 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3229d8ee51a3a4b0cb8384c2291c72813c3187c4
+  data.tar.gz: 6477ff26a3e5fb74afa512d7b700d92dd0805708
+SHA512:
+  metadata.gz: ddb51650cc63b23c412f94887f0c4e7f82547757c84fb8b59e42caeed75a90a1923155733c814ee54771c5d55e7bf55d084b424037883ed9d10e20bbc922eacc
+  data.tar.gz: 2bb2a3320871c9b258b2672823ddc13535b92c297b7bbeadf5ecee4d11bf7588689fc2f254fc2c803fd4092d799873eeb89905ba7c8570f928eb07aa99fcd678

data/.env.example

@@ -0,0 +1,3 @@
+BLISS_SERVER=http://localhost:3000
+BLISS_CLIENT_ID=yourID
+BLISS_CLIENT_SECRET=youSecret

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Fadendaten GmbH
+
+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,205 @@
+# Bliss::Client [![Build Status](https://semaphoreci.com/api/v1/projects/da4b4bec-8734-44c1-afe0-c13d0597fe5b/619317/badge.svg)](https://semaphoreci.com/fadendaten/bliss-client)
+
+Bliss API Ruby client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bliss-client', git: 'git@github.com:fadendaten/bliss-client.git', tag: 'v1.2.0'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+### Authorization
+
+The client requires the following environment variables to be set:
+
+```bash
+BLISS_SERVER=http://sv96.aarboard.ch
+BLISS_CLIENT_ID=34osdljwosdf...
+BLISS_CLIENT_SECRET=24ljsdfo8t34...
+```
+
+## Usage
+
+### Creating a Webshop order
+
+```ruby
+order = Bliss::Client::Order.create(
+  type: :webshop,
+  blizzard_customer_id: 4,
+  items: [
+    {
+      article_id: 3456, # Bliss article id
+      quantity: 2,
+      price_value: 35.20,
+      price_currency: 'CHF'
+    },
+    {
+      article_id: 18462,
+      quantity: 1,
+      price_value: 120,
+      price_currency: 'CHF'
+    }
+  ],
+  delivery_address: {
+    salutation: 'Mr Spongebob Squarepants',
+    line_1: 'Ananas 3', # optionally pass line_2 and line_3
+    zip_code: '12345',
+    city: 'Bikini Bottom',
+    country_iso3: 'USA'
+  },
+  remote_id: 234, # the id of the local Webshop order
+)
+
+order.id # => id of the Bliss Webshop order
+```
+
+### Fetching collections
+
+Collections and their children model the product catalogue of NILE. The
+`Bliss::Client::Collection` provides a way to fetch that data.
+
+#### Fetching all collections without any children with `.all`
+
+```ruby
+collections = Bliss::Client::Collection.all
+```
+
+This can be useful for fetching all basic information quickly and then use the
+IDs of some collections to get more info via `.find` (see below).
+
+#### Fetch specific collections with `.find`
+
+```ruby
+ids = [88, 90, 91, 21]
+collections = Bliss::Client::Collection.find ids
+```
+
+#### Fetch specific collections and include children with the `include_<whatever>` options
+
+```ruby
+ids = [88, 90, 91, 21]
+collections = Bliss::Client::Collection.find(
+  ids,
+  include_programs: true,
+  include_styles: true,
+  include_articles: true
+)
+
+collections.each do |collection|
+  # Access programs with Collection#programs.
+  collection.programs.each do |program|
+    # Access styles with Program#styles.
+    program.styles # ...
+  end
+end
+```
+
+#### Fetching all necessary data for webshop4
+
+```ruby
+# Make sure we know about all sizes
+Bliss::Client::Size.all.each { # create size options type }
+
+# Say webshop4 needs to know about collection 88, 89 and 90.
+collection_ids = [88, 89, 90]
+
+# We want EVERYTHING!!
+options = {
+  include_programs: true,
+  include_colors: true,
+  include_styles: true,
+  include_articles: true,
+  include_prices: true
+}
+
+collections = Bliss::Client::Collection.find(collection_ids, options)
+
+# Traverse the structure with #each and do whatever you want, e.g.
+collections.each do |collection|
+
+  collection.keylooks.each { # create keylook (aka weblook) }
+  collection.studiolooks.each { # create studiolook }
+
+  collection.programs.each do |program|
+
+    program.colors.each { # create options types }
+
+    program.styles.each do |styles|
+
+      styles.each do |style|
+        # create product
+
+        style.articles.each do |article|
+          # create product variant
+
+          # NOTE: that this will return the article ID blizzard is interested in
+          article.legacy_id
+        end
+
+        # access prices
+        [:chf, :eur].each do |currency|
+          # current prices (may be reduced)
+          style.sales_price(currency)
+          style.purchase_price(currency)
+
+          # original prices (non-reduced)
+          style.original_sales_price(currency)
+          style.original_purchase_price(currency)
+
+          # find out whether the style is discounted, i.e. sold at a reduced
+          # price
+          style.discounted?(currency)
+        end
+      end
+    end
+  end
+end
+```
+
+## Development
+
+To install the dependencies and setup config files:
+
+```bash
+bin/setup
+```
+
+To run the tests:
+
+```bash
+rake
+```
+
+To see faraday output while running tests:
+
+```bash
+BLISS_CLIENT_DEBUG=true rake
+```
+
+For an interactive prompt:
+
+```
+bin/console
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fadendaten/bliss-client.
+
+## 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,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bliss/client"
+require "dotenv"
+require "pry"
+
+Dotenv.load
+
+# 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.
+
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bliss-client.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bliss/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bliss-client"
+  spec.version       = Bliss::Client::VERSION
+  spec.authors       = ["Fadendaten GmbH"]
+  spec.email         = ["support@fadendaten.ch"]
+
+  spec.summary       = "Bliss API client library"
+  spec.homepage      = "http://www.fadendaten.ch/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday", "~> 0.9.2"
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.10.0"
+  spec.add_runtime_dependency "typhoeus", "~> 0.8.0"
+  spec.add_runtime_dependency 'virtus', '~> 1.0.5'
+  spec.add_runtime_dependency 'activemodel', '~> 4.2', '>= 3.2'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "dotenv", "~> 2.0.2"
+  spec.add_development_dependency "minitest", "~> 5.8.3"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+  spec.add_development_dependency "pry-byebug", "~> 3.3.0"
+  spec.add_development_dependency "pry-doc", "~> 0.8.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "vcr", "~> 3.0.0"
+end

data/fixtures/vcr_cassettes/test_connection_speaks_with_api.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/oauth/token
+    body:
+      encoding: UTF-8
+      string: '{"grant_type":"client_credentials","client_id":"938f4d9d2dc0e5e083b9b7522df523ec77815298e489181c07b34dcc98912c93","client_secret":"d3aa293c490e6713eb0783a8e8e6894f33c4886d61b0f5522d46b29d68850dc2"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-XSS-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-store, must-revalidate, private, max-age=0
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Request-Id:
+      - 489fc6ea-bddc-4d1a-ac7e-04965fb6a03d
+      X-Runtime:
+      - '0.029444'
+      Set-Cookie:
+      - __profilin=p%3Dt; path=/, __profilin=p%3Dt; path=/, __profilin=p%3Dt; path=/
+      X-MiniProfiler-Ids:
+      - '["y7bpuf1xhei7uqegwfpd","qkro8e6gzily83mtdaos","g87ldxy2frx3qj59nz26","7ktv8sj5ywkozy0swrry","7xhjbmkhk6ez3k3ojgu1","hzz9f7p4sj9f7nvfpj03","m3j6ppn7tv85th7h9v9b","8zffept08saqj5zbezni","jalp8l0w3khlngo9kbvr","pd4kxfx0jgjlgf6rd0d"]'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"f0e0d91cd53b498889ac91c189f889dac53f9f4d03c87e251dd9496c12aa4141","token_type":"bearer","expires_in":7200,"created_at":1453903541}'
+    http_version: 
+  recorded_at: Wed, 27 Jan 2016 14:05:41 GMT
+recorded_with: VCR 3.0.0

data/fixtures/vcr_cassettes/test_create_creates_an_order_in_bliss_and_sets_id.yml

@@ -0,0 +1,91 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/oauth/token
+    body:
+      encoding: UTF-8
+      string: '{"grant_type":"client_credentials","client_id":"938f4d9d2dc0e5e083b9b7522df523ec77815298e489181c07b34dcc98912c93","client_secret":"d3aa293c490e6713eb0783a8e8e6894f33c4886d61b0f5522d46b29d68850dc2"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-XSS-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-store, must-revalidate, private, max-age=0
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Request-Id:
+      - 624dd1ee-d61a-4f18-8afb-c20e0b6fa819
+      X-Runtime:
+      - '0.027402'
+      Set-Cookie:
+      - __profilin=p%3Dt; path=/, __profilin=p%3Dt; path=/, __profilin=p%3Dt; path=/
+      X-MiniProfiler-Ids:
+      - '["97nnr7ynkluvg1cy2omx","qkro8e6gzily83mtdaos","g87ldxy2frx3qj59nz26","7ktv8sj5ywkozy0swrry","7xhjbmkhk6ez3k3ojgu1","hzz9f7p4sj9f7nvfpj03","m3j6ppn7tv85th7h9v9b","8zffept08saqj5zbezni","jalp8l0w3khlngo9kbvr","pd4kxfx0jgjlgf6rd0d"]'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"17023f6443564cc958801a18f708347a616d4dacc8cc62966b36a3341c3c0b65","token_type":"bearer","expires_in":7200,"created_at":1453903541}'
+    http_version: 
+  recorded_at: Wed, 27 Jan 2016 14:05:41 GMT
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/orders?access_token=17023f6443564cc958801a18f708347a616d4dacc8cc62966b36a3341c3c0b65
+    body:
+      encoding: UTF-8
+      string: '{"blizzard_customer_id":4,"type":"webshop","items":[{"article_id":3456,"price_value":"0.352E2","price_currency":"CHF","quantity":2},{"article_id":18462,"price_value":"0.12E3","price_currency":"CHF","quantity":1}],"delivery_address":{"salutation":"Mr
+        Spongebob Squarepants","line_1":"Ananas 3","line_2":null,"line_3":null,"zip_code":"12345","city":"Bikini
+        Bottom","country_iso3":"CHE"},"remote_id":234}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Authorization:
+      - Token token="17023f6443564cc958801a18f708347a616d4dacc8cc62966b36a3341c3c0b65"
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: 
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '48'
+      ETag:
+      - W/"628b5e68d4b0eea91671f59a31cc6080"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - dfb2c70b-c4ab-46ee-bb7f-aaa4303850d1
+      X-Runtime:
+      - '0.153022'
+      Set-Cookie:
+      - __profilin=p%3Dt; path=/, __profilin=p%3Dt; path=/
+      Connection:
+      - keep-alive
+      Server:
+      - thin
+    body:
+      encoding: UTF-8
+      string: '{"id":25122,"created_at":"2016-01-27T14:05:41Z"}'
+    http_version: 
+  recorded_at: Wed, 27 Jan 2016 14:05:41 GMT
+recorded_with: VCR 3.0.0