shadow_cabinet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c7d851f2e66541dedd6f0ee304a55c2cd6951a3
+  data.tar.gz: f2cd55dca943163cfd9073a1a3a332cc7560854d
+SHA512:
+  metadata.gz: 2bc35e6ff56f09b8134d3f22b5290de521d3c2823d6ca751d114138aadd7532f1b1e67938b710e3cbbd37999b4dc32014bc20942ed225a3dd8da5026c680f777
+  data.tar.gz: b223b04db5624e6081477f26010dedf4b9e2d2afb5baf56e0145e0d3a331f9bc6072495f0bcad1a54cbd9c84e9b2c9942073140bedccca5ac3d9209df33c08e9

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*~
+*.swp

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+stormwatch-client

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dennis Walters
+
+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,39 @@
+# Stormwatch
+
+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/stormwatch`. 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 'stormwatch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stormwatch
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/stormwatch.
+
+## 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 "shadow_cabinet"
+
+# 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/lib/shadow_cabinet.rb

@@ -0,0 +1,25 @@
+require 'shadow_cabinet/client'
+require 'shadow_cabinet/version'
+
+module ShadowCabinet
+  def self.client(url:, key:, secret:)
+    Client::Real.new(url: url, key: key, secret: secret)
+  end
+
+  def self.update_box(api, id, content)
+    begin
+      data = api.put(
+        path: "/boxes/#{id}",
+        data: {
+          "box" => {
+            "content" => content
+          }
+        }.to_json
+      )
+    rescue
+      return false
+    end
+
+    true
+  end
+end

data/lib/shadow_cabinet/client.rb

@@ -0,0 +1,9 @@
+module ShadowCabinet
+  module Client
+    Unimplemented = Class.new(StandardError)
+    TransportError = Class.new(StandardError)
+  end
+end
+
+#require 'shadow_cabinet/client/mock'
+require 'shadow_cabinet/client/real'

data/lib/shadow_cabinet/client/base.rb

@@ -0,0 +1,87 @@
+require 'addressable/uri'
+require 'shadow_cabinet/client/result'
+
+module ShadowCabinet
+  module Client
+    class Base
+      attr_reader :url, :key, :secret
+
+      def initialize(url:, key:, secret:)
+        @url = url
+        @key = key
+        @secret = secret
+      end
+
+      def get(path:, params: {})
+        result = make_request(
+          verb: :get,
+          request_url: construct_url(path: path, params: params)
+        )
+
+        raise result.error if result.error_present?
+
+        result.body
+      end
+
+      def post(path:, params: {}, data: nil)
+        result = make_request(
+          verb: :post,
+          request_url: construct_url(path: path, params: params),
+          data: data
+        )
+
+        raise result.error if result.error_present?
+
+        result.body
+      end
+
+      def put(path:, params: {}, data: nil)
+        result = make_request(
+          verb: :put,
+          request_url: construct_url(path: path, params: params),
+          data: data
+        )
+
+        raise result.error if result.error_present?
+
+        result.body
+      end
+
+      def delete(path:, params: {})
+        result = make_request(
+          verb: :delete,
+          request_url: construct_url(path, params)
+        )
+
+        raise result.error if result.error_present?
+
+        result.body
+      end
+
+      private
+
+      def make_request(verb:, request_url:, data: nil)
+        Result.new(
+          error: Unimplmented.new(
+            "#make_request is not defined for #{self.class}"
+          )
+        )
+      end
+
+      def base_url
+        @base_url ||= Addressable::URI.parse(url)
+      end
+
+      def construct_url(path:, params: {})
+        base_url.tap do |url|
+          url.path = File.join('/', 'api', 'v1', path)
+
+          url.query_values = params
+
+          return url
+        end
+      end
+
+    end
+  end
+end

data/lib/shadow_cabinet/client/real.rb

@@ -0,0 +1,35 @@
+require 'faraday'
+require 'shadow_cabinet/client/base'
+require 'shadow_cabinet/client/real/request'
+
+module ShadowCabinet
+  module Client
+    class Real < Base
+      private
+      def connector
+        @connector ||= Faraday.new(url: base_url) do |faraday|
+          faraday.headers.merge!(
+            {
+              'Content-Type' => 'application/json',
+              'Accept' => 'application/json',
+              'User-Agent' => 'shadow_cabinet-client/0.1.0 (https://github.com/ess/shadow_cabinet-client)',
+              'Authorization' => "#{key}:#{secret}"
+            }
+          )
+
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      def make_request(verb:, request_url:, data: nil)
+        Request.perform(
+          verb: verb,
+          connector: connector,
+          request_url: request_url,
+          data: data
+        )
+      end
+    end
+  end
+end

data/lib/shadow_cabinet/client/real/request.rb

@@ -0,0 +1,20 @@
+require 'shadow_cabinet/client/base'
+require 'shadow_cabinet/client/real/request/put'
+
+module ShadowCabinet
+  module Client
+    class Real < Base
+      module Request
+        KNOWN = {
+          put: Put,
+        }
+
+        def self.perform(verb:, connector:, request_url:, data: nil)
+          (KNOWN[verb] || Base).
+            new(connector: connector, request_url: request_url, data: data).
+            perform
+        end
+      end
+    end
+  end
+end

data/lib/shadow_cabinet/client/real/request/base.rb

@@ -0,0 +1,74 @@
+require 'json'
+
+require 'shadow_cabinet/client/base'
+require 'shadow_cabinet/client/result'
+
+module ShadowCabinet
+  module Client
+    class Real < Base
+      module Request
+        # A request is an implementation of an HTTP verb in terms of the Engine
+        # Yard Core API. This is the base class for all Requests.
+        class Base
+
+          attr_reader :connector, :request_url, :data
+
+          def initialize(connector:, request_url:, data: nil)
+            @connector = connector
+            @request_url = request_url
+            @data = data
+          end
+
+          def perform
+            Result.new(
+              error: Unimplemented.new(
+                "that operation is not implemented"
+              )
+            )
+          end
+
+          private
+          def path
+            request_url.path
+          end
+
+          def params
+            @params = request_url.query_values || {}
+          end
+
+          def process_response(response)
+            body = response.body
+
+            status = response.status.to_i
+
+            if status < 200 || status > 299
+              api_errors = 
+                begin
+                  JSON.parse(body, symbolize_names: true)[:errors] || []
+                rescue
+                  []
+                end
+
+              if api_errors.empty?
+                return Result.new(
+                  error: TransportError.new(
+                    "API returned a #{status} status"
+                  )
+                )
+              else
+                return Result.new(
+                  error: CoreError.new(
+                    "Could not process request. The following issues were identified:\n#{api_errors.map(&:to_s).join("\n")}"
+                  )
+                )
+              end
+            end
+
+            Result.new(body: body)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/shadow_cabinet/client/real/request/put.rb

@@ -0,0 +1,25 @@
+require 'shadow_cabinet/client/base'
+require 'shadow_cabinet/client/real/request/base'
+
+module ShadowCabinet
+  module Client
+    class Real < Base
+      module Request
+        # Implementation for the HTTP PUT verb
+        class Put < Base
+
+          def perform
+            response = connector.put(path, data) do |req|
+              params.keys.each do |key|
+                req.params[key] = params[key]
+              end
+            end
+
+            process_response(response)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/shadow_cabinet/client/result.rb

@@ -0,0 +1,20 @@
+module ShadowCabinet
+  module Client
+    # A structure used within client implementations to encapsulate the result
+    # of a given operation. The result contains both a body and an error. If
+    # an error is present, the body should be ignored and the error should be
+    # handled (or raised). Otherwise, the body should be considered the de-facto
+    # result of the operation. This pattern is stolen from Rust, Go, Haskell and
+    # the like, but done so in a VERY naive manner.
+    Result = Struct.new(:body, :error) do
+      def initialize(body: nil, error: nil)
+        self.body = body
+        self.error = error
+      end
+
+      def error_present?
+        !self.error.nil?
+      end
+    end
+  end
+end

data/lib/shadow_cabinet/version.rb

@@ -0,0 +1,3 @@
+module ShadowCabinet
+  VERSION = "0.1.0"
+end

data/shadow_cabinet.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shadow_cabinet/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shadow_cabinet"
+  spec.version       = ShadowCabinet::VERSION
+  spec.authors       = ["Dennis Walters"]
+  spec.email         = ["dwalters@engineyard.com"]
+
+  spec.summary       = %q{Stormwatch API client}
+  spec.homepage      = "https://github.com/ess/shadow_cabinet"
+  spec.license       = "MIT"
+
+  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_dependency 'addressable', '~> 2.3.8'
+  spec.add_dependency 'faraday', '~> 0.12.1'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: shadow_cabinet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 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'
+description: 
+email:
+- dwalters@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shadow_cabinet.rb
+- lib/shadow_cabinet/client.rb
+- lib/shadow_cabinet/client/base.rb
+- lib/shadow_cabinet/client/real.rb
+- lib/shadow_cabinet/client/real/request.rb
+- lib/shadow_cabinet/client/real/request/base.rb
+- lib/shadow_cabinet/client/real/request/put.rb
+- lib/shadow_cabinet/client/result.rb
+- lib/shadow_cabinet/version.rb
+- shadow_cabinet.gemspec
+homepage: https://github.com/ess/shadow_cabinet
+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.13
+signing_key: 
+specification_version: 4
+summary: Stormwatch API client
+test_files: []