assemble 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1675caa241454e5a914c07e1c99aa07f5b2361a
+  data.tar.gz: bb35c39ca35dc61ecb88ccec11aeb7d4de228816
+SHA512:
+  metadata.gz: 1c2da7ac6ead78913db7363085a3a974b0ae869d921b21b50a0464b09461a0fd80a67f9bfb4376120b854633d4024ad7f7d21533278efb0578d9db5dec29049f
+  data.tar.gz: 27daf55fcb940026929c2af26615d5af94bbed2c78c5155dad469cc84b4826f745f491bbed68de48ace0dd8d106be0911b43ef980bc5ab4c62750d090b446632

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.assemble
+.assemble.security

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'awesome_print'
+gem 'guard-bundler'
+gem 'guard-rspec'
+gem 'pry-nav'
+
+group :test do
+  gem 'rspec', '~> 3.0'
+end

data/Guardfile

@@ -0,0 +1,12 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch(%r|^spec/{support,matchers}/(.+)\.rb$|)     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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,29 @@
+# Rivet
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rivet'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rivet
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rivet/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/assemble.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'assemble/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "assemble"
+  spec.version       = Assemble::VERSION
+  spec.authors       = ["Josh Lane"]
+  spec.email         = ["me@joshualane.com"]
+  spec.summary       = %q{Rally REST API Client}
+  spec.description   = %q{Cistern-based client for Rally Dev}
+  spec.homepage      = ""
+  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.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "cistern", "~> 0.8"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "addressable"
+end

data/lib/assemble.rb

@@ -0,0 +1,15 @@
+require "assemble/version"
+
+require 'addressable/uri'
+require 'cistern'
+require 'faraday'
+require 'faraday_middleware'
+require 'logger'
+
+module Assemble
+  # Your code goes here...
+end
+
+require 'assemble/logger'
+require 'assemble/response'
+require 'assemble/client'

data/lib/assemble/client.rb

@@ -0,0 +1,121 @@
+class Assemble::Client < Cistern::Service
+
+  model_path "assemble/models"
+  request_path "assemble/requests"
+
+  # tags
+  model :tag
+  collection :tags
+  request :create_tag
+  request :destroy_tag
+  request :get_tag
+  request :get_tags
+  request :update_tag
+
+  requires :token
+
+  recognizes :url, :adapter, :logger, :connection_options, :version
+
+  class Real
+    attr_reader :connection, :url
+
+    def initialize(options={})
+      base_url = options[:url] || ENV['RALLY_URL'] || "https://rally1.rallydev.com/slm/webservice/"
+      version  = options[:version] || "v3.0"
+
+      @url   = URI.parse(File.join(base_url, version))
+      logger = options[:logger] || Logger.new(nil)
+      @token = options[:token]
+
+      adapter            = options[:adapter] || Faraday.default_adapter
+      connection_options = options[:connection_options] || {}
+
+      @connection = Faraday.new({url: @url}.merge(connection_options)) do |builder|
+        # response
+        builder.response :json
+
+        # request
+        builder.request :retry,
+          :max                 => 5,
+          :interval            => 1,
+          :interval_randomness => 0.05,
+          :backoff_factor      => 2
+        builder.request :multipart
+        builder.request :json
+
+        builder.use Assemble::Logger, logger
+
+        builder.adapter(*adapter)
+      end
+    end
+
+    def request(options={})
+      method  = (options[:method] || "get").to_s.downcase.to_sym
+      url     = Addressable::URI.parse(options[:url] || File.join(@url.to_s, options[:path] || "/"))
+      url.query_values = (url.query_values || {}).merge(options[:query] || {})
+      params  = options[:params] || {}
+      body    = options[:body]
+      headers = options[:headers] || {}
+
+      if body.nil? && !params.empty?
+        headers["Content-Type"] ||=  "application/x-www-form-urlencoded"
+      end
+      headers.merge!("ZSESSIONID" => @token) if @token
+
+      # Authentication
+      params.merge!(key: @token)
+
+      response = self.connection.send(method) do |req|
+        req.url(url.to_s)
+        req.headers.merge!(headers)
+        req.params.merge!(params)
+        req.body = body
+      end
+
+      Assemble::Response.new(
+        :status  => response.status,
+        :headers => response.headers,
+        :body    => response.body,
+        :request => {
+          :method => method,
+          :url    => url,
+        }
+      ).raise!
+    end
+  end # Real
+
+  class Mock
+
+    def self.data
+      @data ||= begin
+                  {
+                    :tags => {},
+                  }
+                end
+    end
+
+    def response(options={})
+      url     = options[:url] || File.join(@url.to_s, options[:path] || "/")
+      method  = (options[:method] || :get).to_s.to_sym
+      status  = options[:status] || 200
+      body    = options[:body]
+      headers = {
+        "Content-Type" => "application/json; charset=utf-8"
+      }.merge(options[:headers] || {})
+
+      Assemble::Response.new(
+        :status  => status,
+        :headers => headers,
+        :body    => body,
+        :request => {
+          :method => method,
+          :url    => url,
+        }
+      ).raise!
+    end
+
+    def url_for(path)
+      File.join(@url, path)
+    end
+  end # Mock
+end # Assemble::Client

data/lib/assemble/logger.rb

@@ -0,0 +1,30 @@
+class Assemble::Logger < Faraday::Response::Middleware
+  extend Forwardable
+
+  def initialize(app, logger = nil)
+    super(app)
+    @logger = logger || ::Logger.new(nil)
+  end
+
+  def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+  def call(env)
+    debug "REQUEST: #{env[:method].upcase} #{env[:url].to_s}"
+    debug('request') { dump_headers env[:request_headers] }
+    debug('request.body') { env[:body] }
+    super
+  end
+
+  def on_complete(env)
+    debug "RESPONSE: #{env[:status]} #{env[:method].upcase} #{env[:url].to_s}"
+    debug('response') { dump_headers env[:response_headers] }
+    debug('response.body') { env[:body] }
+    debug('')
+  end
+
+  private
+
+  def dump_headers(headers)
+    (headers || {}).map { |k,v| "#{k}: #{v.inspect}" }.join("\n")
+  end
+end

data/lib/assemble/models/tag.rb

@@ -0,0 +1,25 @@
+class Assemble::Client::Tag < Cistern::Model
+
+  identity :id, aliases: ["ObjectID", "_refObjectUUID"]
+
+  attribute :archived, aliases: "Archived", type: :boolean, default: false
+  attribute :name, aliases: ["Name", "_objectName"]
+  attribute :version, aliases: ["VersionId", "_objectVersion"]
+  attribute :created_at, aliases: ["_CreatedDate", "CreationDate"], type: :time
+
+  def save
+    response = if new_record?
+                 self.connection.create_tag(archived: self.archived, name: self.name)
+               else
+                 self.connection.update_tag(self.identity, archived: self.archived, name: self.name)
+               end
+    merge_attributes(response.body["CreateResult"]["Object"])
+  end
+
+  def archive!
+    self.archived = true
+    self.connection.update_tag(self.identity, archived: self.archived)
+  end
+
+  alias destroy archive!
+end

data/lib/assemble/models/tags.rb

@@ -0,0 +1,13 @@
+class Assemble::Client::Tags < Cistern::Collection
+
+  model Assemble::Client::Tag
+
+  def all(options={})
+    results = self.connection.get_tags.body["QueryResult"]["Results"]
+    self.load(results.map { |r| {"id" => r["_refObjectUUID"], "name" => r["_refObjectName"]} })
+  end
+
+  def get(object_id)
+    self.new(self.connection.get_tag(object_id).body["Tag"])
+  end
+end

data/lib/assemble/requests/create_tag.rb

@@ -0,0 +1,11 @@
+class Assemble::Client
+  class Real
+    def create_tag(attributes)
+      request(
+        :body   => {"Tag" => attributes},
+        :path   => "/tag/create",
+        :method => :post,
+      )
+    end
+  end # Real
+end

data/lib/assemble/requests/destroy_tag.rb

@@ -0,0 +1,11 @@
+class Assemble::Client
+  class Real
+    def destroy_tag(id)
+      request(
+        :body   => {"Tag" => attributes},
+        :path   => "/tag/create",
+        :method => :post,
+      )
+    end
+  end # Real
+end

data/lib/assemble/requests/get_tag.rb

@@ -0,0 +1,10 @@
+class Assemble::Client
+  class Real
+    def get_tag(id)
+      request(
+        :body => nil,
+        :path => "/tags/#{id}",
+      )
+    end
+  end # Real
+end

data/lib/assemble/requests/get_tags.rb

@@ -0,0 +1,9 @@
+class Assemble::Client
+  class Real
+    def get_tags(params={})
+      request(
+        :path => "/tags",
+      )
+    end
+  end # Real
+end

data/lib/assemble/requests/update_tag.rb

@@ -0,0 +1,11 @@
+class Assemble::Client
+  class Real
+    def update_tag(id, attributes)
+      request(
+        :body   => {"Tag" => attributes},
+        :path   => "/tag/#{id}",
+        :method => :post,
+      )
+    end
+  end # Real
+end

data/lib/assemble/response.rb

@@ -0,0 +1,63 @@
+class Assemble::Response
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super(
+        {
+          :body    => response.body,
+          :headers => response.headers,
+          :request => response.request,
+          :status  => response.status,
+        }.inspect
+      )
+    end
+
+    def errors
+      response.body["errors"]
+    end
+
+    def full_messages
+      if errors.is_a?(Hash)
+        errors.inject([]){|r,(k,v)| r += v.map{|s| "#{k.capitalize} #{s}"}}
+      else # Array or String
+        errors
+      end
+    end
+  end
+
+  BadRequest    = Class.new(Error)
+  NotFound      = Class.new(Error)
+  Unprocessable = Class.new(Error)
+  Conflict      = Class.new(Error)
+  Unexpected    = Class.new(Error)
+
+  EXCEPTION_MAPPING = {
+    400 => BadRequest,
+    404 => NotFound,
+    409 => Conflict,
+    422 => Unprocessable,
+    500 => Unexpected,
+  }
+
+  attr_reader :headers, :status, :body, :request
+
+  def initialize(options={})
+    @status  = options[:status]
+    @headers = options[:headers]
+    @body    = options[:body]
+    @request = options[:request]
+  end
+
+  def successful?
+    self.status >= 200 && self.status <= 299 || self.status == 304
+  end
+
+  def raise!
+    if !successful?
+      raise((EXCEPTION_MAPPING[self.status] || Error).new(self))
+    else self
+    end
+  end
+end

data/lib/assemble/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+ENV['MOCK_ASSEMBLE'] ||= 'true'
+ENV['RALLY_URL'] ||= "https://rally1.rallydev.com/slm/webservice/"
+
+Bundler.require(:test, :default)
+
+require File.expand_path("../../lib/assemble", __FILE__)
+
+Dir[File.expand_path("../{shared,support}/*.rb", __FILE__)].each { |f| require(f) }
+
+Cistern.formatter = Cistern::Formatter::AwesomePrint
+
+if ENV['MOCK_ASSEMBLE'] == 'true'
+  Assemble::Client.mock!
+end
+
+Assemble::Client::Mock.timeout       = 0
+Assemble::Client::Mock.poll_interval = 0
+Assemble::Client::Real.timeout       = 10
+
+RSpec.configure do |config|
+  config.filter_run_excluding(mock_only: true) unless ENV['MOCK_ASSEMBLE'] == "true"
+  config.order = :random
+
+  config.before(:each) do
+    Assemble::Client.reset! if Assemble::Client.mocking?
+  end
+end

data/spec/support/client_helper.rb

@@ -0,0 +1,11 @@
+module ClientHelper
+  def create_client(options={})
+    client_options = {}
+    client_options.merge!(token: options[:token] || File.read(File.expand_path("../../../.assemble", __FILE__)).strip)
+    client_options.merge!(logger: Logger.new(STDOUT)) if ENV["VERBOSE"]
+
+    Assemble::Client.new(client_options)
+  end
+end
+
+RSpec.configure { |config| config.include(ClientHelper) }

data/spec/tags_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'tags' do
+  let!(:client) { create_client }
+  let!(:tag) { client.tags.create(name: "assemble") }
+
+  after(:each) { tag.destroy}
+
+  it "should get tags" do
+    expect(client.tags.all.map(&:id)).to include(tag.identity)
+  end
+
+  it "should get a tag" do
+    fetched = client.tags.get(tag.identity)
+
+    expect(tag.name).to eq("assemble")
+    expect(fetched).to eq(tag)
+    expect(fetched.name).to eq("assemble")
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: assemble
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Lane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: cistern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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'
+description: Cistern-based client for Rally Dev
+email:
+- me@joshualane.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assemble.gemspec
+- lib/assemble.rb
+- lib/assemble/client.rb
+- lib/assemble/logger.rb
+- lib/assemble/models/tag.rb
+- lib/assemble/models/tags.rb
+- lib/assemble/requests/create_tag.rb
+- lib/assemble/requests/destroy_tag.rb
+- lib/assemble/requests/get_tag.rb
+- lib/assemble/requests/get_tags.rb
+- lib/assemble/requests/update_tag.rb
+- lib/assemble/response.rb
+- lib/assemble/version.rb
+- spec/spec_helper.rb
+- spec/support/client_helper.rb
+- spec/tags_spec.rb
+homepage: ''
+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: Rally REST API Client
+test_files:
+- spec/spec_helper.rb
+- spec/support/client_helper.rb
+- spec/tags_spec.rb
+has_rdoc: