labelary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29390c82c16e578804bd475ba6e6281bdc20fdeb
+  data.tar.gz: 3e684e1c454a745dbdaa88a88c131ca11e50ea66
+SHA512:
+  metadata.gz: ad081eb939b53d154d92932a9efe1ba7a7abb7324d2beda2ebb8451d15d0e5dad3a0e779e60b4203b4c1aa1ec0db80e1971f4774ed735b5f6e3c5d75dcb1a757
+  data.tar.gz: 9ffaeb7cd26fbb1e00eef7ff0df5669ceec78a7e4a02bbebcb4b910454f2f62d4ca09bf46dac14bfb99482e8164c43ddc49eb31bb134ce83279a739d4aad927c

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Robert Coleman
+
+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,100 @@
+# Labelary
+
+Labelary ZPL (Zebra Printer Language) Web Service API Client for Ruby.
+
+**Features:**
+
+* Render ZPL strings as PNG or PDF.
+* Encode images to ZPL.
+* Global configuration or per-request.
+
+Web service details and instructions: http://labelary.com/service.html
+
+Supported ZPL commands: http://labelary.com/docs.html
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'labelary'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install labelary
+
+## Configuration
+
+Configuration is available, you can set this per request or in an initializer like so:
+
+```ruby
+# config/initializers/labelary.rb
+Labelary.configure do |config|
+  config.dpmm   = 8 # required
+  config.width  = 3.98 # required (inches)
+  config.height = 6.85 # required (inches)
+  config.index = 0 # optional, for picking a label when multiple are present in the ZPL (usually 0)
+  config.content_type = 'image/png' # or 'application/pdf', specifies the content type of the returned label
+  config.url = 'http://api.labelary.com' # optional (for self hosted)
+end
+```
+
+## Usage
+
+### Rendering Labels
+
+Pass in a width, height, dpmm (or set defaults in your configuration block) and a ZPL string to have it rendered as a PNG or PDF.
+
+```ruby
+Labelary::Label.render zpl: '^XA^FDHello World^FS^XZ', content_type: 'image/png', dpmm: 8, width: 6, height: 4
+#> PNG blob
+```
+
+Or with configuration:
+
+```ruby
+# config/initializers/labelary.rb
+Labelary.configure do |config|
+  config.dpmm   = 8
+  config.width  = 6
+  config.height = 4
+  config.content_type = 'application/pdf'
+end
+
+# elsewhere e.g. lib/label_render.rb
+Labelary::Label.render zpl: '^XA^FDHello World^FS^XZ'
+#> PDF blob
+```
+
+### ZPL Encoding Images
+
+Pass in an image (or an IO object) and it's mime type and you'll get back a ZPL encoded version.
+
+```ruby
+Labelary::Image.encode path: '/path/to/image.png', mime_type: 'image/png'
+#> "^GFA,6699,6699,87,,::lR01F,SNIP,:^FS"
+
+Labelary::Image.encode file_io: IO.read('/path/to/image.png'), filename: 'image.png', mime_type: 'image/png'
+#> "^GFA,6699,6699,87,,::lR01F,SNIP,:^FS"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/rjocoleman/labelary.
+
+
+## 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 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'labelary'
+
+require 'pry'
+Pry.start

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/labelary.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'labelary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'labelary'
+  spec.version       = Labelary::VERSION
+  spec.authors       = ['Robert Coleman']
+  spec.email         = ['github@robert.net.nz']
+
+  spec.summary       = %q{Ruby Gem to interact with the Labelary.com ZPL Web Service}
+  spec.description   = %q{Ruby Gem to interact with the Labelary.com ZPL Web Service}
+  spec.homepage      = 'https://github.com/rjocoleman/labelary'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.10'
+end

data/lib/labelary.rb

@@ -0,0 +1,9 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'labelary/label'
+require 'labelary/image'
+
+require 'labelary/client'
+require 'labelary/configuration'
+require 'labelary/version'

data/lib/labelary/client.rb

@@ -0,0 +1,23 @@
+module Labelary
+  class Client
+    def self.connection(*args)
+      self.new(*args).connection
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: config.url) do |faraday|
+        faraday.request :multipart
+        faraday.response :json, content_type: /\bjson$/
+
+        faraday.adapter config.http_adapter
+      end
+    end
+
+    private
+
+    def config
+      @config ||= Labelary.configuration
+    end
+
+  end
+end

data/lib/labelary/configuration.rb

@@ -0,0 +1,36 @@
+module Labelary
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor *[
+      :url,
+      :http_adapter,
+      :dpmm,
+      :width,
+      :height,
+      :index,
+      :content_type,
+    ]
+
+    def initialize
+      @url          = 'http://api.labelary.com'
+      @http_adapter = Faraday.default_adapter
+      @dpmm         = nil
+      @width        = nil
+      @height       = nil
+      @index        = 0
+      @content_type = 'image/png'
+    end
+
+  end
+end

data/lib/labelary/image.rb

@@ -0,0 +1,26 @@
+module Labelary
+  class Image
+    def self.encode(*args)
+      self.new(*args).encode
+    end
+
+    def initialize(path:nil, mime_type:, filename:nil, file_io:nil)
+      if path.present?
+        @file = Faraday::UploadIO.new path, mime_type
+      elsif file_io.present? && filename.present?
+        @file = Faraday::UploadIO.new file_io, mime_type, filename
+      else
+        raise 'Path to image and MIME type or an IO object, filename and MIME type must be specified.'
+      end
+    end
+
+    # http://labelary.com/faq.html#image-conversion
+    def encode
+      response = Labelary::Client.connection.post '/v1/graphics', { file: @file }, { Accept: 'application/json' }
+      image = response.body
+
+      return '^GFA,' + image['totalBytes'].to_s + ',' + image['totalBytes'].to_s + ',' + image['rowBytes'].to_s + ',' + image['data'] + '^FS'
+    end
+
+  end
+end

data/lib/labelary/label.rb

@@ -0,0 +1,33 @@
+module Labelary
+  class Label
+    def self.render(*args)
+      self.new(*args).render
+    end
+
+    def initialize(dpmm: nil, width: nil, height: nil, index: nil, zpl:, content_type: nil)
+      @zpl    ||= zpl
+      @dpmm   ||= dpmm   || config.dpmm
+      @width  ||= width  || config.width
+      @height ||= height || config.height
+      @index  ||= index  || config.index
+      @content_type ||= content_type || config.content_type
+
+      raise 'Invalid dpmm'   if @dpmm.nil?
+      raise 'Invalid width'  if @width.nil?
+      raise 'Invalid height' if @height.nil?
+    end
+
+    # http://labelary.com/service.html
+    def render
+      response = Labelary::Client.connection.post "/v1/printers/#{@dpmm}dpmm/labels/#{@width}x#{@height}/#{@index}/", @zpl, { Accept: @content_type }
+      return response.body
+    end
+
+    private
+
+    def config
+      @config ||= Labelary.configuration
+    end
+
+  end
+end

data/lib/labelary/version.rb

@@ -0,0 +1,3 @@
+module Labelary
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: labelary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Ruby Gem to interact with the Labelary.com ZPL Web Service
+email:
+- github@robert.net.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- labelary.gemspec
+- lib/labelary.rb
+- lib/labelary/client.rb
+- lib/labelary/configuration.rb
+- lib/labelary/image.rb
+- lib/labelary/label.rb
+- lib/labelary/version.rb
+homepage: https://github.com/rjocoleman/labelary
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Gem to interact with the Labelary.com ZPL Web Service
+test_files: []