seriline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c594d722c243050ad034e3637907fdb19a17bceb
+  data.tar.gz: 2f08a08f3360645eac5ae52c82544b1526938d89
+SHA512:
+  metadata.gz: db3d664d2b0652f33e3af16d68d4bfd9c86c74a3cf36e1e05fbfcfa2ee3f2ac80453101b84d2439ce1799852a9acdb31428c8ae72c94d27da5858415c94487a1
+  data.tar.gz: 880e4fd68f94023a0090613c345e2724da8885ca643287104745363ccf5dd3ccff427b4a455c07fd79b5b60bcd42b7b2fa6c155ea7cb10b8509f547447bd2dcc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in seriline.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    seriline (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    public_suffix (3.0.1)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      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.0)
+    safe_yaml (1.0.4)
+    webmock (3.2.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  seriline!
+  webmock (~> 3.2)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emric
+
+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,90 @@
+# Seriline
+Seriline provides an API for ordering their products. This gem provides a simple method
+for connecting and using the API.
+# Configuration
+For any Seriline request you must first login.
+A session will be active for 60 minutes and during that session you can
+use the other parts of the API.
+
+You can store details with a configuration block:
+```ruby
+# configure Seriline details
+Seriline.configure do |config|
+  config.username = username
+  config.api_key = api_key
+end
+```
+# Usage
+All actions execute requests to the seriline API. This means something
+could go wrong on the way. All returned data however; is returned as an
+object with the `success?` method. If a request fails you can use that flag
+along with `error_message` to troubleshoot eventual client problems.
+## Authentication
+To connect to the API either do it with block syntax:
+```ruby
+Seriline::Client.with_connection do |client|
+  # <- Your awesome code goes here
+end
+```
+
+Or manually by instantiating `Seriline::Client`:
+```ruby
+client = Seriline::Client.new
+client.login
+# <- Your awesome code goes here
+client.logout
+```
+
+Both are the same. Using block syntax you won't have to worry about logging in and out.
+If you have not configured seriline with username and api key you can provide that to any
+of those methods.
+
+- [X] `GET api/Authentication/Login?username={username}&apiKey={apiKey}`
+- [X] `GET api/Authentication/Logout?sessionKey={sessionKey}`
+
+## Configproducts
+A config product is a custom product which you can order.
+
+You can list your available config products like so:
+```ruby
+Seriline::Client.with_connection do |client|
+  client.get_available_config_products
+end
+```
+This returns a `AvailableConfigProductsResponse`. From that you can access the products with `AvailableConfigProductsResponse#products.`
+
+When you have your product id you can proceed to do a single order.
+```ruby
+Seriline::Client.with_connection do |client|
+  client.order_config_product(my_product_id, data)
+end
+```
+This will return a `ConfigProductSingleOrderResponse` object which amongst other
+things contains `order_id`. This key can be used for looking up more information
+about this specific order and should thus be kept.
+
+- [X] `GET api/ConfigProduct/GetAvailable?sessionKey={sessionKey}`
+- [ ] `GET api/ConfigProduct/GetConfigProductInfo?sessionKey={sessionKey}&productId={productId}	`
+- [X] `POST api/ConfigProduct/SingleOrder`
+- [ ] `POST api/ConfigProduct/BatchOrder`
+- [ ] `GET api/ConfigProduct/GetProductionData?sessionKey={sessionKey}&configProductId={configProductId}`
+
+### Cards
+- [ ] `GET api/Card/GetProducedCards?sessionKey={sessionKey}&fromDateTime={fromDateTime}&toDateTime={toDateTime}`
+- [ ] `GET api/Card/GetNotProducedCards?sessionKey={sessionKey}`
+- [ ] `GET api/Card/GetCardPersonPhoto?sessionKey={sessionKey}&cardId={cardId}`
+- [ ] `GET api/Card/GetCardStatusChanges?sessionKey={sessionKey}&fromDateTime={fromDateTime}`
+- [ ] `GET api/Card/ChangeCardStatus?sessionKey={sessionKey}&configProductId={configProductId}&action={action}`
+
+### Accessories
+- [ ] `GET api/Accessories/GetAvailable?sessionKey={sessionKey}`
+
+### Orders
+You can get information about an order by user `Seriline::Order`.
+```ruby
+Seriline::Client.with_connection do |client|
+  client.get_order_info(order_id)
+end
+```
+
+- [X] `GET api/Order/GetOrderInfo?sessionKey={sessionKey}&orderId={orderId}`

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

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/seriline.rb

@@ -0,0 +1,23 @@
+require "seriline/version"
+require "seriline/request"
+require "seriline/session"
+require "seriline/order"
+require "seriline/errors"
+require "seriline/endpoint"
+require "seriline/config_product"
+require "seriline/client"
+
+module Seriline
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :username, :api_key
+  end
+end

data/lib/seriline/client.rb

@@ -0,0 +1,68 @@
+require "seriline/responses/login_response"
+require "seriline/session"
+
+module Seriline
+  class Client
+    attr_reader :username,
+                :api_key,
+                :session
+
+    def initialize(username = Seriline.config.username, api_key = Seriline.config.api_key)
+      @username = username
+      @api_key = api_key
+      @session = Seriline::Session.new
+    end
+
+    def self.with_connection(username = Seriline.config.username, api_key = Seriline.config.api_key)
+      client = Seriline::Client.new(username, api_key)
+      self.client_connection(client) { yield }
+    end
+
+    def self.client_connection(client)
+      client.login
+      yield(client) if client.session.active?
+    ensure
+      client.logout
+    end
+
+    def login
+      return if @session.active?
+      Seriline::Request.get(
+        Seriline::Endpoint.login_path,
+        { username: @username, apiKey: @api_key }
+      ).tap(&store_session_info)
+    end
+
+    def logout
+      return unless @session.active?
+      Seriline::Request.get(
+        Seriline::Endpoint.logout_path,
+        { sessionKey: @session.session_key }
+      ).tap(&destroy_session_info)
+    end
+
+    def get_available_config_products
+      ConfigProduct.get_available(@session)
+    end
+
+    def order_config_product(product_id, data)
+      ConfigProduct.order(@session, product_id, data)
+    end
+
+    def get_order_info(order_id)
+      Order.get_order_info(session, order_id)
+    end
+
+    private
+
+    def store_session_info
+      lambda { |response|
+        @session = Seriline::Session.new Seriline::LoginResponse.new(response)
+      }
+    end
+
+    def destroy_session_info
+      -> (_response) { @session = Seriline::Session.new }
+    end
+  end
+end

data/lib/seriline/config_product.rb

@@ -0,0 +1,22 @@
+require "seriline/responses/config_product_single_order_response"
+require "seriline/responses/available_config_products_response"
+require "seriline/request"
+
+module Seriline
+  class ConfigProduct
+    def self.get_available(session)
+      result = Request.get(Seriline::Endpoint.get_available_config_products_path,
+                           { sessionKey: session.session_key })
+      Seriline::AvailableConfigProductsResponse.new(result)
+    end
+
+    def self.order(session, product_id, data = {})
+      result = Request.post(Seriline::Endpoint.config_product_single_order_path,
+                            {
+                              sessionKey: session.session_key,
+                              Specification: { ProductId: product_id }
+                            }.merge(data))
+      Seriline::ConfigProductSingleOrderResponse.new(result)
+    end
+  end
+end

data/lib/seriline/endpoint.rb

@@ -0,0 +1,21 @@
+require "uri"
+
+module Seriline
+  class Endpoint
+    BASE_URI  = "https://api.webconnect.cloud/v2/api"
+
+    {
+      login: "/Authentication/Login",
+      logout: "/Authentication/Logout",
+      get_available_config_products: "/ConfigProduct/GetAvailable",
+      config_product_single_order: "/ConfigProduct/SingleOrder",
+      get_order_info: "/Order/GetOrderInfo"
+    }.each do |action, path|
+      define_singleton_method("#{action}_path") do |query = {}|
+        URI(BASE_URI + path).tap do |uri|
+          uri.query = URI.encode_www_form(query)
+        end
+      end
+    end
+  end
+end

data/lib/seriline/errors.rb

@@ -0,0 +1,18 @@
+module Seriline
+  class Error < StandardError; end
+
+  class RequestFailedError < Error
+    def initialize(net_http_error)
+      super build_message(net_http_error)
+    end
+
+    private
+
+    def build_message(net_http_error)
+      %(
+        Net::HTTP failed to execute request with the following status:
+        Status: #{net_http_error.code}
+      )
+    end
+  end
+end

data/lib/seriline/order.rb

@@ -0,0 +1,14 @@
+require "seriline/responses/order_info_response"
+
+module Seriline
+  class Order
+    def self.get_order_info(session, order_id)
+      result = Request.get(Seriline::Endpoint.get_order_info_path,
+                          {
+                            sessionKey: session.session_key,
+                            orderId: order_id
+                          })
+      Seriline::OrderInfoResponse.new(result)
+    end
+  end
+end

data/lib/seriline/request.rb

@@ -0,0 +1,63 @@
+require "net/http"
+require "net/https"
+require "json"
+
+module Seriline
+  class Request
+    class << self
+      def get(uri, body = {})
+        Request.new(uri).execute(body)
+      end
+
+      def post(uri, body = {})
+        Request.new(uri, method: "POST")
+               .execute(body)
+      end
+    end
+
+    def initialize(uri, method: "GET")
+      @method = method
+      @uri = URI(uri)
+    end
+
+    def execute(body = {})
+      response = http.request(request_object(body))
+      evaluate_response(response)
+      return parse_response(response)
+    end
+
+    private
+
+    def http
+      @http ||= Net::HTTP.new(@uri.host, @uri.port)
+                         .tap do |http_instance|
+        http_instance.use_ssl = true
+        http_instance.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+
+    def evaluate_response(response)
+      response.value
+    rescue
+      raise Seriline::RequestFailedError.new(response)
+    end
+
+    def parse_response(response)
+      return {} if response.body.empty?
+      JSON.parse(response.body, {quirks_mode: true})
+    end
+
+    def request_object(body)
+      @request_object ||= case @method
+                          when "GET"
+                            @uri.query = URI.encode_www_form(body)
+                            Net::HTTP::Get.new(@uri)
+                          when "POST"
+                            Net::HTTP::Post.new(@uri).tap do |req|
+                              req.content_type = "application/json"
+                              req.body = body.to_json
+                            end
+                          end
+    end
+  end
+end

data/lib/seriline/response_data.rb

@@ -0,0 +1,44 @@
+
+# This class represents a simple struct like object.
+# - Permitted attributes must be defined with `attr_reader`
+# - When initialized attribute keys will be snake cased.
+#   For example { CamelCase: "Hello world!" }
+#   would set the instance variable @camel_case
+#
+# Example:
+#
+# class PersonResponse < Seriline::ResponseData
+#   attr_reader :name, :email
+# end
+#
+# PersonResponse.new({
+#   name: "Bob",
+#   email: "bob-the-builder@gmail.com",
+#   password: "secret"
+# })
+#
+#=> #<PersonResponse:0x007fca321df778 @name="Bob", @email="bob-the-builder@gmail.com">
+module Seriline
+  class ResponseData
+    def initialize(attributes = {})
+      attributes.each do |attribute, value|
+        reader_name = snake_case(attribute)
+        next unless respond_to? reader_name
+        instance_variable_set("@#{reader_name}", value)
+      end
+    end
+
+    def success?
+      success
+    end
+
+    private
+
+    def snake_case(string)
+      string = string.to_s
+      scan = string.scan(/[A-Z]*[a-z]+/)
+      return string.downcase if scan.empty?
+      scan.map(&:downcase) * "_"
+    end
+  end
+end

data/lib/seriline/responses/available_config_products_response.rb

@@ -0,0 +1,22 @@
+require "seriline/response_data"
+
+module Seriline
+  class AvailableConfigProductsResponse < Seriline::ResponseData
+    attr_reader :success, :error_message, :products
+
+    def initialize(attributes = {})
+      super(attributes)
+      serialize_products
+    end
+
+    private
+
+    def serialize_products
+      @products = @products.map {|product_hash| AvailableConfigProductNode.new(product_hash) }
+    end
+  end
+
+  class AvailableConfigProductNode < Seriline::ResponseData
+    attr_reader :product_id, :name, :short_description, :is_batch_product
+  end
+end

data/lib/seriline/responses/config_product_single_order_response.rb

@@ -0,0 +1,7 @@
+require "seriline/response_data"
+
+module Seriline
+  class ConfigProductSingleOrderResponse < Seriline::ResponseData
+    attr_reader :success, :error_message, :order_id, :config_product_id
+  end
+end

data/lib/seriline/responses/login_response.rb

@@ -0,0 +1,19 @@
+require "seriline/response_data"
+
+module Seriline
+  class LoginResponse < Seriline::ResponseData
+    attr_reader :success, :session_key, :error_message, :valid_to
+
+    def initialize(attributes)
+      super(attributes)
+      parse_valid_to
+    end
+
+    private
+
+    def parse_valid_to
+      return if @valid_to.nil?
+      @valid_to = Time.parse(@valid_to.to_s)
+    end
+  end
+end

data/lib/seriline/responses/order_info_response.rb

@@ -0,0 +1,7 @@
+require "seriline/response_data"
+
+module Seriline
+  class OrderInfoResponse < Seriline::ResponseData
+    attr_reader :success, :error_message, :order_id, :status
+  end
+end

data/lib/seriline/session.rb

@@ -0,0 +1,22 @@
+require "seriline/responses/login_response"
+require "time"
+
+module Seriline
+  class Session
+    attr_reader :login_response
+
+    def initialize(login_response = nil)
+      @login_response = login_response
+    end
+
+    def active?
+      @login_response &&
+        @login_response.success &&
+        @login_response.valid_to > Time.now
+    end
+
+    def session_key
+      @login_response && @login_response.session_key
+    end
+  end
+end

data/lib/seriline/version.rb

@@ -0,0 +1,3 @@
+module Seriline
+  VERSION = "0.1.0"
+end

data/seriline.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "seriline/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "seriline"
+  spec.version       = Seriline::VERSION
+  spec.authors       = ["Emric"]
+  spec.email         = ["w.e.w@live.se"]
+
+  spec.summary       = %q{A gem for integrating with the Serline API}
+  spec.homepage      = "https://github.com/standout/seriline"
+  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"] = "https://rubygems.org"
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.2"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: seriline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emric
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- w.e.w@live.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seriline.rb
+- lib/seriline/client.rb
+- lib/seriline/config_product.rb
+- lib/seriline/endpoint.rb
+- lib/seriline/errors.rb
+- lib/seriline/order.rb
+- lib/seriline/request.rb
+- lib/seriline/response_data.rb
+- lib/seriline/responses/available_config_products_response.rb
+- lib/seriline/responses/config_product_single_order_response.rb
+- lib/seriline/responses/login_response.rb
+- lib/seriline/responses/order_info_response.rb
+- lib/seriline/session.rb
+- lib/seriline/version.rb
+- seriline.gemspec
+homepage: https://github.com/standout/seriline
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A gem for integrating with the Serline API
+test_files: []