deis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d486dfde4bf3ddf99e7b268102d05d975e3230b
+  data.tar.gz: 969be0a9de1d8cab31ec775b08612dfd1a895b63
+SHA512:
+  metadata.gz: 4e869cc7ca519b4a27f50e4c3df88f94c8ac786222deae52896feeb2a4878c879741eb5aea7ac61e341b12f8954e595dae3bb0f8f5a9bf28036141290c37bd71
+  data.tar.gz: 4a4d380222469535eda7faa4ffe70879286925f63a5fd1d1a977ea1e2b6403c75581f1205246e36a1e56deb354d1504af36d4a2a344ff2c911d2d80369bef577

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "awesome_print"
+  gem "faker"
+  gem "rspec", "~> 3.2"
+  gem 'pry-nav'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Josh Lane
+
+MIT License
+
+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,31 @@
+# Deis
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deis'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deis
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/deis/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/deis.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deis"
+  spec.version       = Deis::VERSION
+  spec.authors       = ["Josh Lane"]
+  spec.email         = ["jlane@engineyard.com"]
+  spec.summary       = %q{Ruby API Client for Deis Controller API}
+  spec.description   = %q{http://docs.deis.io/en/v1.3.0/reference/api-v1.0/}
+  spec.homepage      = "http://github.com/engineyard/deis"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "cistern", "~> 0.11"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "ey-logger", "~> 0.0"
+end

data/lib/deis.rb

@@ -0,0 +1,14 @@
+require "deis/version"
+
+require 'logger'
+
+require 'cistern'
+require 'faraday'
+require 'faraday_middleware'
+require 'ey/logger'
+require 'ey/logger/faraday'
+
+module Deis
+end
+
+require 'deis/client'

data/lib/deis/client.rb

@@ -0,0 +1,22 @@
+class Deis::Client < Cistern::Service
+  collection_path "deis/client/collections"
+  model_path      "deis/client/models"
+  request_path    "deis/client/requests"
+
+  collection :users
+  model :user
+  request :register_user
+
+  recognizes :url, :logger, :adapter, :username, :password, :token
+
+  requires :url
+
+  module Shared
+    def authenticated?
+      !! @auth_token
+    end
+  end
+end
+
+require 'deis/client/real'
+require 'deis/client/mock'

data/lib/deis/client/collections/users.rb

@@ -0,0 +1,5 @@
+class Deis::Client::Users < Cistern::Collection
+
+  model Deis::Client::User
+
+end

data/lib/deis/client/mock.rb

@@ -0,0 +1,79 @@
+class Deis::Client::Mock
+  include Deis::Client::Shared
+
+  attr_reader :username, :url, :password, :token
+
+  def self.data
+    @data ||= Hash.new { |h, url|
+      h[url] = {
+        :users => {},
+      }
+    }
+  end
+
+  def self.reset!
+    @data = nil
+  end
+
+  def self.serial_id
+    @current_id ||= 0
+    @current_id += 1
+    @current_id.to_s
+  end
+
+  def data
+    self.class.data[@url]
+  end
+
+  def serial_id
+    self.class.serial_id
+  end
+
+  def initialize(options={})
+    @url                 = options[:url]
+    @username, @password = options[:username], options[:password]
+    @auth_token          = options[:token]
+  end
+
+  def response(options={})
+    method = options[:method] || :get
+    status = options[:status] || 200
+    path   = options[:path]
+    body   = options[:body]
+    url    = options[:url] || File.join(@url, "api/v1", path)
+
+    request_headers  = {
+      "Accept"       => "application/json",
+      "Content-Type" => "application/json",
+    }
+
+    response_headers = {
+      "Content-Type"            => "application/json",
+      "x_deis_api_version"      => "1.1",
+      "x_deis_platform_version" => "1.2.2",
+    }
+
+    # request phase
+    # * :method - :get, :post, ...
+    # * :url    - URI for the current request; also contains GET parameters
+    # * :body   - POST parameters for :post/:put requests
+    # * :request_headers
+
+    # response phase
+    # * :status - HTTP response status code, such as 200
+    # * :body   - the response body
+    # * :response_headers
+
+    env = Faraday::Env.from(
+      :method           => method,
+      :url              => URI.parse(url),
+      :body             => body,
+      :request_headers  => request_headers,
+      :response_headers => response_headers,
+      :status           => status,
+    )
+
+    Faraday::Response::RaiseError.new.on_complete(env) ||
+      Faraday::Response.new(env)
+  end
+end

data/lib/deis/client/models/user.rb

@@ -0,0 +1,26 @@
+class Deis::Client::User < Cistern::Model
+  identity :id, type: :integer
+
+  attribute :email,            type: :string
+  attribute :first_name,       type: :string
+  attribute :groups,           type: :array
+  attribute :is_staff,         type: :string
+  attribute :is_superuser,     type: :string
+  attribute :last_name,        type: :string
+  attribute :user_permissions, type: :array
+  attribute :username,         type: :string
+
+  attr_accessor :password
+
+  def save
+    if new_record?
+      merge_attributes(
+        connection.register_user(
+          Cistern::Hash.stringify_keys(self.attributes.merge("password" => self.password))
+        ).body
+      )
+    else
+      raise NotImplementedError # not available ?
+    end
+  end
+end

data/lib/deis/client/real.rb

@@ -0,0 +1,55 @@
+class Deis::Client::Real
+
+  include Deis::Client::Shared
+
+  attr_accessor :username, :url, :logger
+
+  def initialize(options={})
+    @url      = options.fetch(:url)
+    @logger   = options[:logger]   || Logger.new(nil)
+    adapter   = options[:adapter]  || Faraday.default_adapter
+    @username = options[:username]
+    password  = options[:password]
+    token     = options[:token]
+
+
+    @auth_token = password || token
+
+    connection_options = options[:connection_options] || {}
+
+    @connection = Faraday.new({url: @url}.merge(connection_options)) do |builder|
+      # response
+      if username && auth_token
+        builder.use Faraday::Request::BasicAuthentication, @username, @auth_token
+      end
+
+      builder.use Faraday::Response::RaiseError
+      builder.response :json
+
+      # request
+      builder.request :multipart
+      builder.request :json
+
+      builder.use Ey::Logger::Faraday, format: :machine, device: @logger, prefix: "deis"
+      builder.adapter adapter
+    end
+  end
+
+  def request(options={})
+    method  = options[:method] || :get
+    url     = options[:url] || File.join(@url, "v1", options.fetch(:path))
+    params  = options[:params] || {}
+    body    = options[:body]
+    headers = {
+      "Content-Type" => "application/json",
+      "Accept"       => "application/json",
+    }.merge(options[:headers] || {})
+
+    @connection.send(method) do |req|
+      req.url(url)
+      req.headers.merge!(headers)
+      req.params.merge!(params)
+      req.body = body
+    end
+  end
+end

data/lib/deis/client/requests/register_user.rb

@@ -0,0 +1,59 @@
+class Deis::Client::Real
+  # @see http://docs.deis.io/en/v1.3.0/reference/api-v1.0/#register-a-new-user
+  def register_user(params={})
+    request(
+      :path   => "auth/register",
+      :method => :post,
+      :body   => Cistern::Hash.slice(params, "username", "password", "email", "first_name", "last_name"),
+    )
+  end
+end
+
+class Deis::Client::Mock
+  def register_user(params={})
+    id = self.serial_id
+
+    unless params["username"]
+      response(
+        :body   => {"username" => "This field is required."},
+        :status => 400,
+      )
+    end
+
+    unless params["password"]
+      response(
+        :body   => {"password" => "This field is required."},
+        :status => 400,
+      )
+    end
+
+    user_params = Cistern::Hash.slice(params, "username", "password", "email", "first_name", "last_name").merge(
+      "id"               => id,
+      "is_active"        => true,
+      "is_staff"         => false,
+      "groups"           => [],
+      "user_permissions" => [],
+      "is_superuser"     => false,
+    )
+
+    if self.data[:users].keys.empty?
+      user_params.merge!("is_staff" => true, "is_superuser" => true)
+    end
+
+    if self.data[:users].values.find { |u| u["username"] == user_params["username"] }
+      response(
+        :body   => {"username" => "User with this Username already exists."},
+        :status => 400,
+      )
+    end
+
+    self.data[:users][id] = user_params
+
+    response(
+      :path   => "/auth/register",
+      :method => :post,
+      :body   => user_params,
+      :status => 201,
+    )
+  end
+end

data/lib/deis/version.rb

@@ -0,0 +1,3 @@
+module Deis
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+ENV['MOCK_DEIS'] ||= 'true'
+
+Bundler.require(:test)
+
+require File.expand_path("../../lib/deis", __FILE__)
+
+Dir[File.expand_path("../{support,shared}/**/*.rb", __FILE__)].each {|f| require f}
+
+if ENV["MOCK_DEIS"] == 'true'
+  Deis::Client.mock!
+end
+
+Cistern.formatter = Cistern::Formatter::AwesomePrint
+
+RSpec.configure do |config|
+  if Deis::Client.mocking?
+    config.before(:each) { Deis::Client.reset! }
+  else
+    config.filter_run_excluding(mock_only: true)
+  end
+
+  config.order = "random"
+end

data/spec/support/client_helper.rb

@@ -0,0 +1,27 @@
+require 'logger'
+
+module ClientHelper
+  def create_anonymous_client(options={})
+    options.merge!(logger: Logger.new(STDOUT)) if ENV['VERBOSE']
+    options = {
+      :url => ENV["DEIS_URL"] || "https://deis.example.org",
+    }.merge(options)
+
+    Deis::Client.new(options)
+  end
+
+  def create_authorized_client(options={})
+    options.merge!(logger: Logger.new(STDOUT)) if ENV['VERBOSE']
+    options = {
+      :username => ENV["DEIS_USERNAME"],
+      :password => ENV["DEIS_PASSWORD"],
+      :url      => ENV["DEIS_URL"] || "https://deis.example.org",
+    }.merge(options)
+
+    Deis::Client.new(options)
+  end
+end
+
+RSpec.configure do |config|
+  config.include(ClientHelper)
+end

data/spec/users_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe "as an anonymous client" do
+  let!(:client) { create_anonymous_client }
+
+  it "should create a user" do
+    username = SecureRandom.hex(6)
+    password = SecureRandom.hex(6)
+    email    = Faker::Internet.email
+
+    client.users.create(email: email, username: username, password: password)
+
+    if Deis::Client.mocking?
+      user = client.data[:users].values.first
+
+      expect(user["email"]).to    eq(email)
+      expect(user["username"]).to eq(username)
+      expect(user["password"]).to eq(password)
+    end
+  end
+
+  describe "#register_user" do
+    it "should create a new user" do
+      response = client.register_user(
+        "username" => (username = SecureRandom.hex(6)),
+        "password" => (password = SecureRandom.hex(6)),
+        "email"    => Faker::Internet.email,
+      )
+
+      expect(response.status).to eq(201)
+
+      user = response.body
+
+      expect(user["username"]).to eq(username)
+      expect(user["password"]).to eq(password)
+
+      if Deis::Client.mocking?
+        expect(user["is_superuser"]).to eq(true)
+        expect(user["is_staff"]).to     eq(true)
+      end
+
+      response = client.register_user(
+        "username" => SecureRandom.hex(6),
+        "password" => SecureRandom.hex(6),
+      )
+
+      another_user = response.body
+
+      expect(another_user["is_superuser"]).to eq(false)
+      expect(another_user["is_staff"]).to     eq(false)
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: deis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Lane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: cistern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ey-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: http://docs.deis.io/en/v1.3.0/reference/api-v1.0/
+email:
+- jlane@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deis.gemspec
+- lib/deis.rb
+- lib/deis/client.rb
+- lib/deis/client/collections/users.rb
+- lib/deis/client/mock.rb
+- lib/deis/client/models/user.rb
+- lib/deis/client/real.rb
+- lib/deis/client/requests/register_user.rb
+- lib/deis/version.rb
+- spec/spec_helper.rb
+- spec/support/client_helper.rb
+- spec/users_spec.rb
+homepage: http://github.com/engineyard/deis
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby API Client for Deis Controller API
+test_files:
+- spec/spec_helper.rb
+- spec/support/client_helper.rb
+- spec/users_spec.rb
+has_rdoc: