dasher-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa5e96cc84dc470f8f048514db42cf977c0576a1
+  data.tar.gz: 4665e9ec8ca11bec51e21a66c8e01725c2183ee9
+SHA512:
+  metadata.gz: b1f2465224a7c14313a8bf3139945614847c48233e5c9cd29bff7d5ed8a7168d15ff0c17aff8db107c2ec8607bf767e75ae7c69c70c5b3427d36fad69f0bef69
+  data.tar.gz: 2245dc6e9e5d53bd3ee5f5932601217b27897aa52c64d8df6912ec14b90676b468297fec13c5ee6b533c6dad1b87143cad9edd4445e35538b09db35942bc666f

data/README.md

@@ -0,0 +1,50 @@
+# Dasher Ruby Client
+
+This client allows you to easily update screen data for [Dasher](http://dasherapp.com).
+You can use this gem to easily push new data to any of your Dasher screens with
+ease.
+
+## Installation
+
+Just install the gem into your `Gemfile` to get started.
+
+```ruby
+gem "dasher-ruby", "~> 1.0", :require => "dasher"
+```
+
+## Usage
+
+```ruby
+# Getting screen and square information
+Dasher.client.screens       #=>   Returns an array of screens
+Dasher.client.screen(1)     #=>   Return information about a given screen by ID
+
+# You can update a specific property quickly by providing the path to the property
+# you want to change. You should provide the ID (or path) to the square, the
+# key of the property you want to change and the new value.
+Dasher.client.update_property(2, "number", 4001)
+Dasher.client.update_property("screen1.signups", "number", 4001)
+
+# Updating lists is also easy. You provide the square ID (or path), an optional
+# identifier allowing you to remove/edit this item again in the future and the
+# properties for the list item.
+Dasher.client.add_list_item(2, nil, {"text" => "Some properties", "color" => "red"})
+
+# You can also provide a full new list of updates. Screens will automatically
+# remove, add or edit items as appropriate. Any items without identifiers will
+# be removed.
+Dasher.client.replace_list(2, [
+  {"identifier" => "A", {"text" => "Some example text on row A"}},
+  {"identifier" => "B", {"text" => "Some example text on row B"}}
+])
+```
+
+The `Dasher.client` instance is automatically configured to use the production
+Dasher endpoints and the key in the `Dasher_TOKEN` environment variable.
+You can create your own clients if you would like.
+
+```ruby
+client = Dasher::Client.new(host, token, :port => 443, :ssl => true)
+client.screens
+# etc...
+```

data/lib/dasher/client.rb

@@ -0,0 +1,48 @@
+require 'moonrope_client'
+
+module Dasher
+  class Client
+
+    attr_reader :host, :token, :port, :ssl
+
+    def initialize(host, token, options = {})
+      @host = host
+      @token = token
+      @port = options[:port]
+      @ssl = options[:ssl]
+    end
+
+    def screens
+      api.screens.list!.data
+    end
+
+    def screen(id)
+      api.screens.details!(:id => id).data
+    end
+
+    def update_property(square, key, value)
+      api.squares.update_property!(:square => square, :key => key, :value => value).data
+    rescue MoonropeClient::RequestError => e
+      e.result.data["code"] == "ValidationError" ? false : raise
+    end
+
+    def add_list_item(square, identifier, properties = {})
+      api.lists.add!(:square => square, :identifier => identifier, :properties => properties)
+    end
+
+    def replace_list(square, items = [])
+      api.lists.replace!(:square => square, :items => items)
+    rescue MoonropeClient::RequestError => e
+      puts e.result.data
+    end
+
+    private
+
+    def api
+      @client ||= begin
+        MoonropeClient::Connection.new(host, :headers => {'X-Auth-Token' => token}, :ssl => port == 443, :port => port)
+      end
+    end
+
+  end
+end

data/lib/dasher/version.rb

@@ -0,0 +1,3 @@
+module Dasher
+  VERSION = '1.0.0'
+end

data/lib/dasher.rb

@@ -0,0 +1,11 @@
+require 'dasher/client'
+
+module Dasher
+
+  class << self
+    def client
+      @client ||= Dasher::Client.new("dasherapp.com", ENV["DASHER_TOKEN"], :port => 443, :ssl => true)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: dasher-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: moonrope-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A full client library allows requests to made to the Dasher API.
+email:
+- adam@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/dasher.rb
+- lib/dasher/client.rb
+- lib/dasher/version.rb
+homepage: https://dasherapp.com
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Ruby client library for the Dasher API.
+test_files: []