labelary 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29390c82c16e578804bd475ba6e6281bdc20fdeb
-  data.tar.gz: 3e684e1c454a745dbdaa88a88c131ca11e50ea66
+  metadata.gz: 1a162c74bb9e9c778da52f11edd04dfe37bf7f94
+  data.tar.gz: a4798e56be3ae88fdf34eead27e627621cf6a6d0
 SHA512:
-  metadata.gz: ad081eb939b53d154d92932a9efe1ba7a7abb7324d2beda2ebb8451d15d0e5dad3a0e779e60b4203b4c1aa1ec0db80e1971f4774ed735b5f6e3c5d75dcb1a757
-  data.tar.gz: 9ffaeb7cd26fbb1e00eef7ff0df5669ceec78a7e4a02bbebcb4b910454f2f62d4ca09bf46dac14bfb99482e8164c43ddc49eb31bb134ce83279a739d4aad927c
+  metadata.gz: 84eeaeeac3ef9b38c9591d961e46d5c703b81b437f9c5f64fe6e24fe80b885ee6c58fef643733350bf70961705c29961a3d0903bfd72a463bc6765ccba9772aa
+  data.tar.gz: 5543b9ac8bfc95c5673c86754a9259161782097658b134a3adf6b0da92e7d42a30068f0154b11094a0f916e69dd4fd27c935a3537cabfbf3c7a2c612ad7ca805

data/README.md

@@ -1,5 +1,7 @@
 # Labelary
 
+[![Gem Version](https://badge.fury.io/rb/labelary.svg)](https://badge.fury.io/rb/labelary)
+
 Labelary ZPL (Zebra Printer Language) Web Service API Client for Ruby.
 
 **Features:**
@@ -7,6 +9,7 @@ Labelary ZPL (Zebra Printer Language) Web Service API Client for Ruby.
 * Render ZPL strings as PNG or PDF.
 * Encode images to ZPL.
 * Global configuration or per-request.
+* Helper method for including fonts.
 
 Web service details and instructions: http://labelary.com/service.html
 
@@ -49,7 +52,7 @@ end
 
 ### 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.
+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
@@ -72,6 +75,18 @@ Labelary::Label.render zpl: '^XA^FDHello World^FS^XZ'
 #> PDF blob
 ```
 
+#### Fonts
+
+Fonts can be included automatically via config, or per request, using the `font` argument. To do this pass in the correctly formatted `^DU` command as a string.
+
+For example if you've got a Zebra font package such as [Swiss 721](https://support.zebra.com/cpws/docs/fonts/DownloadSwiss721.htm)
+
+You also need to configure fonts.
+
+```ruby
+Labelary::Label.render zpl: '^XA^A@,,,E:TT0003M_.FNT^FDHello World^FS^XZ', font: File.read('./swiss-721-font/77849_002.ZSU')
+```
+
 ### 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.
@@ -84,11 +99,58 @@ Labelary::Image.encode file_io: IO.read('/path/to/image.png'), filename: 'image.
 #> "^GFA,6699,6699,87,,::lR01F,SNIP,:^FS"
 ```
 
+### Rails Example
+
+It's reasonably straight-forward to incorporate this into a Rails project if you wish. Here's an example in a controller:
+
+```ruby
+# config/initializers/labelary.rb
+Labelary.configure do |config|
+  config.dpmm   = 8
+  config.width  = 6
+  config.height = 4
+end
+
+# config/initializers/mime_types.rb
+Mime::Type.register 'text/plain', :zpl
+```
+
+```
+# app/views/labels/label.zpl.erb
+^XA^FDHello <%= @label.name_for_earth %>^FS^XZ
+```
+
+```ruby
+# app/controllers/labels_controller.rb
+class LabelsController < ApplicationController
+
+  # snip
+
+  def label
+    @label = Label.find params[:id]
+    zpl_string = render_to_string formats: [:zpl]
+
+    respond_to do |format|
+      format.zpl
+      format.png { get_rendered_zpl zpl_string }
+      format.pdf { get_rendered_zpl zpl_string, 'application/pdf' }
+    end
+  end
+
+  private
+
+  def get_rendered_zpl(zpl_string, content_type='image/png')
+    rendered_zpl = Labelary::Label.render zpl: zpl_string, content_type: content_type
+    send_data rendered_zpl, type: content_type, disposition: 'inline'
+  end
+end
+```
+
 ## 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/labelary/configuration.rb

@@ -20,6 +20,7 @@ module Labelary
       :height,
       :index,
       :content_type,
+      :font
     ]
 
     def initialize
@@ -30,6 +31,7 @@ module Labelary
       @height       = nil
       @index        = 0
       @content_type = 'image/png'
+      @font         = nil
     end
 
   end

data/lib/labelary/label.rb

@@ -4,13 +4,14 @@ module Labelary
       self.new(*args).render
     end
 
-    def initialize(dpmm: nil, width: nil, height: nil, index: nil, zpl:, content_type: nil)
+    def initialize(dpmm: nil, width: nil, height: nil, index: nil, zpl:, content_type: nil, font: 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
+      @font ||= font || config.font
 
       raise 'Invalid dpmm'   if @dpmm.nil?
       raise 'Invalid width'  if @width.nil?
@@ -19,7 +20,8 @@ module Labelary
 
     # 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 }
+      payload = @font.present? ? @font.to_s + @zpl : @zpl
+      response = Labelary::Client.connection.post "/v1/printers/#{@dpmm}dpmm/labels/#{@width}x#{@height}/#{@index}/", payload, { Accept: @content_type }
       return response.body
     end
 

data/lib/labelary/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labelary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert Coleman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler