pivotal 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pivotal.gemspec
+gemspec
+
+group :test do
+  gem "rspec", "~> 2.11.0"
+  gem "guard-rspec"
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thom Mahoney & 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,33 @@
+# Pivotal
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pivotal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pivotal
+
+## Releasing
+
+    gem bump -trv patch
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/pivotal/client.rb

@@ -0,0 +1,70 @@
+require 'logger'
+
+class Pivotal::Client < Cistern::Service
+
+  model_path "pivotal/models"
+  request_path "pivotal/requests"
+
+  model :project
+  collection :projects
+  request :get_project
+  request :get_projects
+
+  model :iteration
+  collection :iterations
+  request :get_iteration
+  request :get_iterations
+
+  model :story
+
+  recognizes :token, :url
+
+  class Real
+
+    def initialize(options={})
+      @token = options[:token] || File.read(File.expand_path("~/.pivotal"))
+      @url   = options[:url]   || "https://www.pivotaltracker.com/services/v3/"
+
+      raise "Missing token" unless @token
+
+      @logger            = options[:logger] || Logger.new(STDOUT)
+      adapter            = options[:adapter] || Faraday.default_adapter
+      connection_options = options[:connection_options] || {ssl: {verify: false}}
+
+      @connection = Faraday.new({url: @url}.merge(connection_options)) do |builder|
+        # response
+        builder.use Faraday::Response::RaiseError
+        builder.response :xml,  :content_type => /\bxml$/
+
+        # request
+        builder.request :multipart
+        builder.request :xml
+
+        builder.use Pivotal::Logger, @logger
+        builder.adapter adapter
+      end
+    end
+
+    def request(options={})
+      method  = options[:method] || :get
+      url     = File.join(@url, options[:path])
+      params  = options[:params] || {}
+      body    = options[:body]
+      headers = {
+        "X-TrackerToken" => @token,
+      }.merge(options[:headers] || {})
+
+      response = @connection.send(method) do |req|
+        req.url(url)
+        req.headers.merge!(headers)
+        req.params.merge!(params)
+        req.body = body
+      end
+    end
+  end # Real
+
+  class Mock
+    def initialize(options={})
+    end
+  end # Mock
+end # Pivotal::Client

data/lib/pivotal/encode_xml.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+
+module Pivotal
+  # Request middleware that encodes the body as xml.
+  #
+  # Processes only requests with matching Content-type or those without a type.
+  # If a request doesn't have a type but has a body, it sets the Content-type
+  # to xml MIME-type.
+  #
+  # Doesn't try to encode bodies that already are in string form.
+  class EncodeXml < Faraday::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+    MIME_TYPE    = 'application/xml'.freeze
+
+    dependency do
+      require 'xmlsimple' unless defined?(XmlSimple)
+    end
+
+    def call(env)
+      match_content_type(env) do |data|
+        env[:body] = encode data
+      end
+      @app.call env
+    end
+
+    def encode(data)
+      XmlSimple.xml_out(data)
+    end
+
+    def match_content_type(env)
+      if process_request?(env)
+        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+        yield env[:body] unless env[:body].respond_to?(:to_str)
+      end
+    end
+
+    def process_request?(env)
+      type = request_type(env)
+      has_body?(env) and (type.empty? or type == MIME_TYPE)
+    end
+
+    def has_body?(env)
+      body = env[:body] and !(body.respond_to?(:to_str) and body.empty?)
+    end
+
+    def request_type(env)
+      type = env[:request_headers][CONTENT_TYPE].to_s
+      type = type.split(';', 2).first if type.index(';')
+      type
+    end
+  end
+end
+
+if Faraday.respond_to? :register_middleware
+  Faraday.register_middleware(:request, {:xml => lambda { Pivotal::EncodeXml }})
+end

data/lib/pivotal/logger.rb

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

data/lib/pivotal/models/iteration.rb

@@ -0,0 +1,19 @@
+class Pivotal::Client::Iteration < Cistern::Model
+  identity :id
+
+  attribute :name
+  attribute :number, type: :integer
+  attribute :start, type: :date
+  attribute :finish, type: :date
+  attribute :team_strength, type: :decimal
+
+  attr_reader :stories
+
+  def iterations
+    self.iterations.all(project_id: self.identity)
+  end
+
+  def stories=(stories_hash)
+    @stories = stories_hash.map{|story| Pivotal::Client::Story.new(story)}
+  end
+end

data/lib/pivotal/models/iterations.rb

@@ -0,0 +1,23 @@
+class Pivotal::Client::Iterations < Cistern::Collection
+  model Pivotal::Client::Iteration
+
+  attribute :project_id
+
+  def all(params={})
+    response = connection.get_iterations(params.merge("project_id" => self.project_id))
+
+    self.clone.load(response.body["iterations"])
+  end
+
+  def current
+    all("id" => "current").first
+  end
+
+  def get(id)
+    if data = connection.get_iteration("project_id" => self.project_id, "id" => id).body["iteration"]
+      new(data)
+    else
+      nil
+    end
+  end
+end

data/lib/pivotal/models/project.rb

@@ -0,0 +1,13 @@
+class Pivotal::Client::Project < Cistern::Model
+  identity :id
+
+  attribute :name
+  attribute :iteration_length, type: :integer
+  attribute :account
+  attribute :current_velocity, type: :integer
+  attribute :memberships
+
+  def iterations
+    connection.iterations.tap{|i| i.project_id = self.identity}
+  end
+end

data/lib/pivotal/models/projects.rb

@@ -0,0 +1,17 @@
+class Pivotal::Client::Projects < Cistern::Collection
+  model Pivotal::Client::Project
+
+  def all(params={})
+    response = connection.get_projects
+
+    self.clone.load(response.body["projects"])
+  end
+
+  def get(id)
+    if data = connection.get_project("id" => id).body["project"]
+      new(data)
+    else
+      nil
+    end
+  end
+end

data/lib/pivotal/models/story.rb

@@ -0,0 +1,26 @@
+class Pivotal::Client::Story < Cistern::Model
+  identity :id
+
+  attribute :accepted_at,  type: :date
+  attribute :created_at,   type: :date
+  attribute :current_state
+  attribute :description
+  attribute :labels
+  attribute :name
+  attribute :owned_by
+  attribute :project_id,   type: :integer
+  attribute :requested_by
+  attribute :story_type
+  attribute :updated_at,   type: :date
+  attribute :url
+
+  attr_reader :stories
+
+  def iterations
+    self.iterations.all(project_id: self.identity)
+  end
+
+  def stories=(stories_hash)
+    @stories = stories.map{|story| Pivotal::Client::Story.new(story)}
+  end
+end

data/lib/pivotal/requests/get_iteration.rb

@@ -0,0 +1,30 @@
+class Pivotal::Client
+  class Real
+    def get_iteration(params={})
+      id         = params["id"]
+      project_id = params["project_id"]
+
+      request(
+        :path => "/projects/#{project_id}/iterations/#{id}"
+      )
+    end
+  end # Real
+  class Mock
+    def get_iteration(params={})
+      id         = params["id"]
+      project_id = params["project_id"]
+      iteration = self.data[:iterations][id]
+
+      if iteration
+        response(
+          :body    => {"iteration" => iteration},
+          :status  => 200
+        )
+      else
+        response(
+          :status  => 404
+        )
+      end
+    end
+  end # Mock
+end

data/lib/pivotal/requests/get_iterations.rb

@@ -0,0 +1,31 @@
+class Pivotal::Client
+  class Real
+    def get_iterations(params={})
+      id         = params["id"]
+      project_id = params["project_id"]
+
+      request(
+        :path => "/projects/#{project_id}/iterations/#{id}"
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_iterations(params={})
+      id         = params["id"]
+      project_id = params["project_id"]
+      iteration = self.data[:iterations][id]
+
+      if iteration
+        response(
+          :body    => {"iteration" => iteration},
+          :status  => 200
+        )
+      else
+        response(
+          :status  => 404
+        )
+      end
+    end
+  end # Mock
+end

data/lib/pivotal/requests/get_project.rb

@@ -0,0 +1,28 @@
+class Pivotal::Client
+  class Real
+    def get_project(params={})
+      id = params["id"]
+
+      request(
+        :path => "/projects/#{id}"
+      )
+    end
+  end # Real
+  class Mock
+    def get_project(params={})
+      id      = params["id"]
+      project = self.data[:projects][id]
+
+      if project
+        response(
+          :body    => {"project" => project},
+          :status  => 200
+        )
+      else
+        response(
+          :status  => 404
+        )
+      end
+    end
+  end # Mock
+end

data/lib/pivotal/requests/get_projects.rb

@@ -0,0 +1,19 @@
+class Pivotal::Client
+  class Real
+    def get_projects(params={})
+      request(
+        :path => "/projects"
+      )
+    end
+  end # Real
+  class Mock
+    def get_projects(params={})
+      projects = self.data[:projects]
+
+      response(
+        :body   => {"projects" => projects},
+        :status => 200
+      )
+    end
+  end # Mock
+end

data/lib/pivotal/version.rb

@@ -0,0 +1,3 @@
+module Pivotal
+  VERSION = "0.0.2"
+end

data/lib/pivotal.rb

@@ -0,0 +1,13 @@
+require "pivotal/version"
+
+require 'cistern'
+require 'xmlsimple'
+require 'faraday'
+require 'faraday_middleware'
+
+module Pivotal
+  require 'pivotal/encode_xml'
+
+  autoload :Client, 'pivotal/client'
+  autoload :Logger, 'pivotal/logger'
+end

data/pivotal.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pivotal/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pivotal"
+  gem.version       = Pivotal::VERSION
+  gem.authors       = ["Josh Lane & Thom Mahoney"]
+  gem.email         = ["jlane@engineyard.com", "tmahoney@engineyard.com"]
+  gem.description   = %q{A client for Pivotal Tracker.}
+  gem.summary       = %q{A client for Pivotal Tracker using cistern and nokogiri.}
+  gem.homepage      = "https://github.com/thommahoney/pivotal"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "cistern", "~> 0.0.3"
+  gem.add_dependency "xml-simple"
+  gem.add_dependency "faraday"
+  gem.add_dependency "faraday_middleware"
+  gem.add_dependency "multi_xml"
+end

data/spec/project_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "projects" do
+  let(:client) { Pivotal::Client.new }
+  let(:project_id) { 635517 }
+
+  it "should fetch all projects" do
+    client.projects.all.should_not be_nil
+  end
+
+  describe "with a specific project" do
+    let(:project) { client.projects.get(project_id) }
+
+    it "should get project's current iteration" do
+      current_iteration = project.iterations.current
+      current_iteration.should_not be_nil
+
+      current_iteration.stories.should_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../../lib/pivotal', __FILE__)
+
+Bundler.require(:test)
+
+Dir[File.expand_path('../{support,matchers}/*.rb', __FILE__)].each{|f| require(f)}
+
+if ENV["MOCK_PIVOTAL"] == "true"
+  Pivotal::Client.mock!
+end
+
+RSpec.configure do |config|
+  config.before(:all) do
+    Pivotal::Client.reset! if Pivotal::Client.mocking?
+  end
+end
+

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: pivotal
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Josh Lane & Thom Mahoney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cistern
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for Pivotal Tracker.
+email:
+- jlane@engineyard.com
+- tmahoney@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pivotal.rb
+- lib/pivotal/client.rb
+- lib/pivotal/encode_xml.rb
+- lib/pivotal/logger.rb
+- lib/pivotal/models/iteration.rb
+- lib/pivotal/models/iterations.rb
+- lib/pivotal/models/project.rb
+- lib/pivotal/models/projects.rb
+- lib/pivotal/models/story.rb
+- lib/pivotal/requests/get_iteration.rb
+- lib/pivotal/requests/get_iterations.rb
+- lib/pivotal/requests/get_project.rb
+- lib/pivotal/requests/get_projects.rb
+- lib/pivotal/version.rb
+- pivotal.gemspec
+- spec/project_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thommahoney/pivotal
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A client for Pivotal Tracker using cistern and nokogiri.
+test_files:
+- spec/project_spec.rb
+- spec/spec_helper.rb