genesis_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8329c2d48302aaf273c20f40f8e18fb15654651b
+  data.tar.gz: 7cbe9bca58f4794abd8c28949522da63620d7322
+SHA512:
+  metadata.gz: f8f7b8100de090ea8ce4295457ca66b5ff581aa49e53033a029172b706f4db1cbd83360b19385e42762536c4ac8a336da5a103a2620be8e536335b03954679b7
+  data.tar.gz: a1739d86965268510804425287acfe4971349ac6a48cffa8292119b7910758cd15c3508429e67aad94b70f7f421d336d7f889d5821d4b36566385c38e55559d1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'bin/*'
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Shopify
+
+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,41 @@
+# GenesisClient
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/genesis_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'genesis_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install genesis_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/genesis_client.
+
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'genesis_client'
+
+# 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

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

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

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'genesis_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'genesis_client'
+  spec.version       = GenesisClient::VERSION
+  spec.authors       = ['David Radcliffe']
+  spec.email         = ['david.radcliffe@shopify.com']
+
+  spec.summary       = 'Ruby client library for the Genesis API'
+  spec.homepage      = 'https://github.com/Shopify/genesis_client'
+  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'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop', '~> 0.39.0'
+
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'faraday_middleware', '~> 0.9.0'
+  spec.add_dependency 'hashie', '~> 3.0'
+end

data/lib/genesis_client.rb

@@ -0,0 +1,6 @@
+require 'genesis_client/version'
+require 'genesis_client/client'
+
+module GenesisClient
+  USER_AGENT = "Shopify/genesis_client/#{GenesisClient::VERSION}".freeze
+end

data/lib/genesis_client/client.rb

@@ -0,0 +1,57 @@
+require 'genesis_client/devices'
+require 'genesis_client/remote_actions'
+require 'faraday_middleware'
+
+module GenesisClient
+  class Client
+    def initialize(options = {})
+      @endpoint = options[:endpoint].to_s
+      @token = options[:token].to_s
+      raise ArgumentError, ":endpoint can't be blank" if @endpoint.empty?
+      raise ArgumentError, ":token can't be blank" if @token.empty?
+    end
+
+    include GenesisClient::Devices
+    include GenesisClient::RemoteActions
+
+    private
+
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, data = {})
+      request(:post, path, data)
+    end
+
+    def put(path, data = {})
+      request(:put, path, data)
+    end
+
+    def request(method, path, data = {})
+      res = connection.send(method, "api/#{path}", data)
+      if res.success? && !res.body.empty? && res.body != ' '
+        res.body
+      else
+        res
+      end
+    end
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new @endpoint do |f|
+        f.request :json
+        f.headers[:user_agent] = GenesisClient::USER_AGENT
+        f.headers['Authorization'] = "Token token=\"#{@token}\""
+
+        # f.response :logger
+        f.response :mashify
+        f.response :json, content_type: /\bjson$/
+
+        f.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/genesis_client/devices.rb

@@ -0,0 +1,44 @@
+module GenesisClient
+  module Devices
+    # Receive a list of all Devices.
+    #
+    # @return [Array<Hashie::Mash>] Array of hashes representing devices.
+    # @example
+    #   client = GenesisClient::Client.new
+    #   client.devices
+    def devices(type = nil)
+      (type.nil? ? get('/devices') : get("/devices?type=#{type}"))['devices']
+    end
+    alias list_devices devices
+
+    # Receive a single Device.
+    #
+    # @return [Hashie::Mash] Hash representing the device.
+    # @param sku [String] The SKU of the device
+    # @example
+    #   client = GenesisClient::Client.new
+    #   client.device('UNK-12345534')
+    def device(sku)
+      get("/devices/#{sku}")['device']
+    end
+
+    # Modify an existing Device.
+    #
+    # @return [Hashie::Mash] Hash representing the device
+    # @param sku [Integer] The SKU of the device
+    # @param data [Hash] Device attributes to update
+    def update_device(sku, data)
+      put("/devices/#{sku}", data)['device']
+    end
+
+    # Create a new Log for a Device.
+    #
+    # @return [Hashie::Mash] Hash representing the log
+    # @param sku [Integer] The SKU of the device
+    # @param message [String] Log message
+    def create_device_log(sku, message)
+      data = { message: message }
+      post("/devices/#{sku}/logs", data)['log']
+    end
+  end
+end

data/lib/genesis_client/remote_actions.rb

@@ -0,0 +1,47 @@
+module GenesisClient
+  module RemoteActions
+    # Receive a list of all Devices.
+    #
+    # @return [Array<Hashie::Mash>] Array of hashes representing remote actions.
+    # @example
+    #   client = GenesisClient::Client.new
+    #   client.remote_actions
+    def remote_actions(zone)
+      filters = {
+        zone: zone
+      }
+      get('/remote_actions', filters)['remote_actions']
+    end
+    alias list_remote_actions remote_actions
+
+    # Receive a single Remote Action.
+    #
+    # @return [Hashie::Mash] Hash representing the remote action.
+    # @param id [String, Integer] The id of the remote action
+    # @example
+    #   client = GenesisClient::Client.new
+    #   client.remote_action('234')
+    def remote_action(id)
+      get("/remote_actions/#{id}")['remote_action']
+    end
+
+    # Modify an existing Remote Action.
+    #
+    # @return [Hashie::Mash] Hash representing the remote action.
+    # @param id [String, Integer] The id of the remote action
+    # @param data [Hash] Remote Action attributes to update
+    def update_remote_action(id, data)
+      put("/remote_actions/#{id}", data)['remote_action']
+    end
+
+    # Create a new Log for a Remote Action.
+    #
+    # @return [Hashie::Mash] Hash representing the log
+    # @param id [String, Integer] The id of the remote action
+    # @param message [String] Log message
+    def create_remote_action_log(id, message)
+      data = { message: message }
+      post("/remote_actions/#{id}/logs", data)['log']
+    end
+  end
+end

data/lib/genesis_client/version.rb

@@ -0,0 +1,3 @@
+module GenesisClient
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: genesis_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Radcliffe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-07 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- david.radcliffe@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- genesis_client.gemspec
+- lib/genesis_client.rb
+- lib/genesis_client/client.rb
+- lib/genesis_client/devices.rb
+- lib/genesis_client/remote_actions.rb
+- lib/genesis_client/version.rb
+homepage: https://github.com/Shopify/genesis_client
+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.6.3
+signing_key: 
+specification_version: 4
+summary: Ruby client library for the Genesis API
+test_files: []
+has_rdoc: