evolis-premium_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a24254811c654b6b0e7101dedeeafeaae18b621
+  data.tar.gz: 243cd2662b01920e5acce05c1401ebbe7143affa
+SHA512:
+  metadata.gz: ea377cdc59fd18f5338fb14c09503c3ac40775ca3a18ddadab6aae84edeb85a76d9d9123d55875f9b93083b5b7b3332850dc23d8c07eb21f09f4c35c54b02697
+  data.tar.gz: f8fee0513e47bec357bf915e4011a39a2ea26c9ca6f0d938ab44da7f66879a76b8a97efb1007e9f66c506fbb06c15d5e3e4b27dde6e379d648e2b54e977c0241

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.idea/
+
+# do not include gems
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at boye.holden@ntnu.no. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Boye Holden
+
+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,45 @@
+# Evolis::PremiumSdk
+
+This gem is a ruby interface for the [Evolis Premium SDK](http://www.evolis.com/software/evolis-premium-sdk-software-development-kit),
+and are therefore based on the documentation from Evolis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'evolis-premium_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install evolis-premium_sdk
+
+## Usage
+
+Require the library and then use the classes as their own services or set up a new Sdk class and use all the other classes from that.
+The code documents the usage.
+
+    require 'evolis/premium_sdk'
+    sdk = Evolis::PremiumSdk::Sdk.new '127.0.0.1', 18000
+    sdk.echo.echo 'Hello World'
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/esselt/evolis-premium_sdk](https://github.com/esselt/evolis-premium_sdk). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,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 "evolis/premium_sdk"
+
+# 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/evolis-premium_sdk.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'evolis/premium_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "evolis-premium_sdk"
+  spec.version       = Evolis::PremiumSdk::VERSION
+  spec.authors       = ["Boye Holden"]
+  spec.email         = ["esselt@esselt.net"]
+
+  spec.summary       = %q{Implements Evolis Premium SDK.}
+  spec.description   = %q{Implements usage of the Evolis Premium Suite SDK so Ruby can communicate with the SDK.}
+  spec.homepage      = "https://github.com/esselt/evolis-premium_sdk"
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "multi_json", "~> 1.12"
+end

data/lib/evolis/premium_sdk.rb

@@ -0,0 +1,52 @@
+require 'evolis/premium_sdk/version'
+require 'evolis/premium_sdk/rpc_client'
+require 'evolis/premium_sdk/addon'
+require 'evolis/premium_sdk/cmd'
+require 'evolis/premium_sdk/echo'
+require 'evolis/premium_sdk/espf'
+require 'evolis/premium_sdk/print'
+require 'evolis/premium_sdk/sdk_base'
+require 'evolis/premium_sdk/setting'
+require 'evolis/premium_sdk/supervision'
+
+module Evolis
+  module PremiumSdk
+    class Sdk
+
+      # @return [Addon]
+      attr_reader :addon
+
+      # @return [Cmd]
+      attr_reader :cmd
+
+      # @return [Echo]
+      attr_reader :echo
+
+      # @return [Espf]
+      attr_reader :espf
+
+      # @return [Print]
+      attr_reader :print
+
+      # @return [Setting]
+      attr_reader :setting
+
+      # @return [Supervision]
+      attr_reader :supervision
+
+      # Initialize child classes so they can be used directly under a Evolis::PremiumSdk.new
+      #
+      # @param host [String] host or IP of SDK
+      # @param port [String, Fixnum] port of SDK
+      def initialize(host, port)
+        @addon       = Addon.new host, port
+        @cmd         = Cmd.new host, port
+        @echo        = Echo.new host, port
+        @espf        = Espf.new host, port
+        @print       = Print.new host, port
+        @setting     = Setting.new host, port
+        @supervision = Supervision.new host, port
+      end
+    end
+  end
+end

data/lib/evolis/premium_sdk/addon.rb

@@ -0,0 +1,28 @@
+require 'evolis/premium_sdk/sdk_base'
+
+module Evolis
+  module PremiumSdk
+    class Addon < SdkBase
+
+      # Initializes the class and sets SDK host and port
+      #
+      # @param host [String] host or IP for SDK
+      # @param port [String, Fixnum] port for SDK
+      def initialize(host, port)
+        super(host, port, 'ADDON')
+      end
+
+      # Executes an application on the server
+      #
+      # @param command [String] what command to launch
+      # @param data [String] parameters to give to command
+      # @return [String] results from command
+      def launch(command, data)
+        call_rpc('Launch', {
+            command: command,
+            data:    data
+        })
+      end
+    end
+  end
+end

data/lib/evolis/premium_sdk/cmd.rb

@@ -0,0 +1,54 @@
+require 'evolis/premium_sdk/sdk_base'
+
+module Evolis
+  module PremiumSdk
+    class Cmd < SdkBase
+      # Default timeout for CMD service
+      TIMEOUT = '3000'
+
+      # Initializes the class and sets SDK host and port
+      #
+      # @param host [String] host or IP for SDK
+      # @param port [String, Fixnum] port for SDK
+      def initialize(host, port)
+        super(host, port, 'CMD')
+      end
+
+      # Sends commands in text or binary format
+      #
+      # @param device [String] printer name
+      # @param command [String] command, in clear text or base64-encoded format
+      # @param timeout [String] communication timeout
+      # @return [String] response to the sent command
+      def send_command(device, command, timeout = TIMEOUT)
+        call_rpc('SendCommand', {
+            command: command,
+            timeout: timeout,
+            device:  device
+        })
+      end
+
+      # Retrieves the binary status of a device
+      #
+      # @param device [String] printer name
+      # @return [String] binary status of the device, see SDK document
+      def get_status(device)
+        call_rpc('GetStatus', {
+            device: device
+        })
+      end
+
+      # Reset communications with a device
+      #
+      # @param device [String] printer name
+      # @param timeout [String] communication timeout
+      # @return [true] if reset successful
+      def reset_com(device, timeout = TIMEOUT)
+        call_rpc('ResetCom', {
+            timeout: timeout,
+            device:  device
+        })
+      end
+    end
+  end
+end

data/lib/evolis/premium_sdk/echo.rb

@@ -0,0 +1,26 @@
+require 'evolis/premium_sdk/sdk_base'
+
+module Evolis
+  module PremiumSdk
+    class Echo < SdkBase
+
+      # Initializes the class and sets SDK host and port
+      #
+      # @param host [String] host or IP for SDK
+      # @param port [String, Fixnum] port for SDK
+      def initialize(host, port)
+        super(host, port, 'ECHO')
+      end
+
+      # Sends a character string to the server
+      #
+      # @param msg [String] character string
+      # @return [String] same as msg parameter
+      def echo(msg)
+        call_rpc('Echo', {
+            data: msg
+        })
+      end
+    end
+  end
+end

data/lib/evolis/premium_sdk/error.rb

@@ -0,0 +1,93 @@
+module Evolis
+  module PremiumSdk
+    module Error
+      class InvalidResponse < StandardError
+        def initialize
+          super('Invalid or empty response from server.')
+        end
+      end
+
+      class InvalidJSON < StandardError
+        def initialize(json)
+          super("Couldn't parse JSON string received from server:\n#{json}")
+        end
+      end
+
+      class ServerError < StandardError
+        attr_reader :code, :response_error
+
+        def initialize(code, message)
+          @code = code
+          @response_error = message
+          super("Server error #{code}: #{message}")
+        end
+      end
+
+      class Base64FormatError < StandardError
+        def initialize(value)
+          super("Value is not valid base64 format: #{value}")
+        end
+      end
+
+      class NoActiveSessionError < StandardError
+        def initialize
+          super('Could not find active session.')
+        end
+      end
+
+      class InvalidPrintSettingError < StandardError
+        def initialize(value)
+          super("Setting or value is invalid print settings: #{value}")
+        end
+      end
+
+      class NoSuchFaceError < StandardError
+        def initialize(face)
+          super("Invalid face for printing: #{face}")
+        end
+      end
+
+      class NoSuchPanelError < StandardError
+        def initialize(panel)
+          super("Invalid panel for printing: #{panel}")
+        end
+      end
+
+      class InvalidExportFormatError < StandardError
+        def initialize(format)
+          super("Invalid format for exporting settings: #{format}")
+        end
+      end
+
+      class InvalidImportFormatError < StandardError
+        def initialize(format)
+          super("Invalid format for importing settings: #{format}")
+        end
+      end
+
+      class InvalidStateLevelError < StandardError
+        def initialize(level)
+          super("Invalid level for listing printer state: #{level}")
+        end
+      end
+
+      class InvalidEventError < StandardError
+        def initialize(event)
+          super("Invalid event for setting state: #{event}")
+        end
+      end
+
+      class InvalidActionError < StandardError
+        def initialize(action)
+          super("Invalid action for setting state: #{action}")
+        end
+      end
+
+      class InvalidParamError < StandardError
+        def initialize(param)
+          super("Invalid parameter or value for ESPF service: #{param}")
+        end
+      end
+    end
+  end
+end