pivotal-api 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8eb153b9cf748c9d9d0f2ecbdeec3ef341963f1
+  data.tar.gz: 02383e644883c0bf292e1cfb5e58bfc223c2c58b
+SHA512:
+  metadata.gz: 32dd22449130691138f408a00626ef3a0826903b23f2a5017583619a4f8d7f06adc831f3d30abd2db08e41b2d0fb553ae4d389bd720bd49e42ee3aed1b0fce9d
+  data.tar.gz: 03716a31c4bf552241b0c3940db729483843662efb31d33461a4d57d52b4dbef6f8b3e6501ec600c4046c2b6f064be5f7ef12be95b532992305c9a9e769d76f7

data/lib/pivotal-api.rb

@@ -0,0 +1,51 @@
+require_relative './pivotal_api/version.rb'
+
+# dependencies
+require 'virtus'
+require 'faraday'
+require 'faraday_middleware'
+
+# stdlib
+require 'addressable/uri'
+require 'forwardable'
+require 'logger'
+
+module PivotalApi
+  autoload :Error, 'pivotal_api/error'
+  autoload :Client, 'pivotal_api/client'
+  autoload :Logger, 'pivotal_api/logger'
+
+  module Errors
+    class UnexpectedData < StandardError; end
+  end
+
+  module Endpoints
+    autoload :Comments, 'pivotal_api/endpoints/comments'
+    autoload :Epics, 'pivotal_api/endpoints/epics'
+    autoload :Iterations, 'pivotal_api/endpoints/iterations'
+    autoload :Labels, 'pivotal_api/endpoints/labels'
+    autoload :Me, 'pivotal_api/endpoints/me'
+    autoload :Memberships, 'pivotal_api/endpoints/memberships'
+    autoload :Projects, 'pivotal_api/endpoints/projects'
+    autoload :Stories, 'pivotal_api/endpoints/stories'
+    autoload :Tasks, 'pivotal_api/endpoints/tasks'
+    autoload :Webhooks, 'pivotal_api/endpoints/webhooks'
+  end
+
+  module Resources
+    autoload :Account, 'pivotal_api/resources/account'
+    autoload :Comment, 'pivotal_api/resources/comment'
+    autoload :Epic, 'pivotal_api/resources/epic'
+    autoload :Iteration, 'pivotal_api/resources/iteration'
+    autoload :Me, 'pivotal_api/resources/me'
+    autoload :MembershipSummary, 'pivotal_api/resources/membership_summary'
+    autoload :Label, 'pivotal_api/resources/label'
+    autoload :Person, 'pivotal_api/resources/person'
+    autoload :Project, 'pivotal_api/resources/project'
+    autoload :ProjectMembership, 'pivotal_api/resources/project_membership'
+    autoload :Story, 'pivotal_api/resources/story'
+    autoload :Task, 'pivotal_api/resources/task'
+    autoload :TimeZone, 'pivotal_api/resources/time_zone'
+    autoload :Webhook, 'pivotal_api/resources/webhook'
+  end
+end

data/lib/pivotal_api/client.rb

@@ -0,0 +1,218 @@
+module PivotalApi
+  class Client
+    USER_AGENT          = "Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}) PivotalApi/#{PivotalApi::VERSION} Faraday/#{Faraday::VERSION}".freeze
+
+    # Header keys that can be passed in options hash to {#get},{#paginate}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    attr_reader :url, :api_version, :token, :logger, :connection, :auto_paginate, :last_response
+
+    # Create Pivotal Tracker API client.
+    #
+    # @param [Hash] options the connection options
+    # @option options [String] :token API token to use for requests
+    # @option options [String] :url Main HTTP API root
+    # @option options [Boolean] :auto_paginate Client should perform pagination automatically. Default true.
+    # @option options [String] :api_version The API version URL path
+    # @option options [String] :logger Custom logger
+    # @option options [String] :adapter Custom http adapter to configure Faraday with
+    # @option options [String] :connection_options Connection options to pass to Faraday
+    #
+    # @example Creating a Client
+    #   Client.new token: 'my-super-special-token'
+    def initialize(options={})
+      url                = options.fetch(:url, 'https://www.pivotaltracker.com')
+      @url               = Addressable::URI.parse(url).to_s
+      @api_version       = options.fetch(:api_version, '/services/v5')
+      @logger            = options.fetch(:logger, ::Logger.new(nil))
+      adapter            = options.fetch(:adapter, :excon)
+      connection_options = options.fetch(:connection_options, { ssl: { verify: true } })
+      @auto_paginate     = options.fetch(:auto_paginate, true)
+      @token             = options[:token]
+      raise 'Missing required options: :token' unless @token
+
+      @connection = Faraday.new({ url: @url }.merge(connection_options)) do |builder|
+        # response
+        builder.use Faraday::Response::RaiseError
+        builder.response :json
+
+        # request
+        builder.request :multipart
+        builder.request :json
+
+        builder.use PivotalApi::Logger, @logger
+        builder.adapter adapter
+      end
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param path [String] The path, relative to api endpoint
+    # @param options [Hash] Query and header params for request
+    # @return [Faraday::Response]
+    def get(path, options = {})
+      request(:get, parse_query_and_convenience_headers(path, options))
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param path [String] The path, relative to api endpoint
+    # @param options [Hash] Query and header params for request
+    # @return [Faraday::Response]
+    def delete(path, options = {})
+      request(:delete, parse_query_and_convenience_headers(path, options))
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param path [String] The path, relative to api endpoint
+    # @param options [Hash] Query and header params for request
+    # @return nil
+    def post(path, options = {})
+      request(:post, parse_query_and_convenience_headers(path, options))
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param path [String] The path, relative to api endpoint
+    # @param options [Hash] Query and header params for request
+    # @return nil
+    def put(path, options = {})
+      request(:put, parse_query_and_convenience_headers(path, options))
+    end
+
+    # Make one or more HTTP GET requests, optionally fetching
+    # the next page of results from information passed back in headers
+    # based on value in {#auto_paginate}.
+    #
+    # @param path [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @param block [Block] Block to perform the data concatenation of the
+    #   multiple requests. The block is called with two parameters, the first
+    #   contains the contents of the requests so far and the second parameter
+    #   contains the latest response.
+    # @return [Array]
+    def paginate(path, options = {}, &block)
+      opts           = parse_query_and_convenience_headers path, options.dup
+      auto_paginate  = opts[:params].delete(:auto_paginate) { |k| @auto_paginate }
+      @last_response = request :get, opts
+      data           = @last_response.body
+      raise PivotalApi::Errors::UnexpectedData, 'Array expected' unless data.is_a? Array
+
+      if auto_paginate
+        pager = Pagination.new @last_response.headers
+
+        while pager.more?
+          opts[:params].update(pager.next_page_params)
+
+          @last_response = request :get, opts
+          pager          = Pagination.new @last_response.headers
+          if block_given?
+            yield(data, @last_response)
+          else
+            data.concat(@last_response.body) if @last_response.body.is_a?(Array)
+          end
+        end
+      end
+
+      data
+    end
+
+    # Get projects
+    #
+    # @return [PivotalApi::Endpoints::Projects]
+    def projects
+      Endpoints::Projects.new(self)
+    end
+
+    # Get information about the authenticated user
+    #
+    # @return [PivotalApi::Resources::Me]
+    def me
+      data = get("/me").body
+
+      Resources::Me.new({ client: self }.merge(data))
+    end
+
+    # Get information about a client story without knowing what project the story belongs to
+    #
+    # @param [String] story_id
+    # @return [PivotalApi::Resources::Story]
+    
+
+    private
+
+    def parse_query_and_convenience_headers(path, options)
+      raise 'Path can not be blank.' if path.to_s.empty?
+
+      opts = { body: options[:body] }
+
+      opts[:url]    = options[:url] || File.join(@url, @api_version, path.to_s)
+      opts[:method] = options[:method] || :get
+      opts[:params] = options[:params] || {}
+      opts[:token]  = options[:token] || @token
+      headers       = { 'User-Agent'     => USER_AGENT,
+                        'X-TrackerToken' => opts.fetch(:token) }.merge(options.fetch(:headers, {}))
+
+      CONVENIENCE_HEADERS.each do |h|
+        if header = options[h]
+          headers[h] = header
+        end
+      end
+      opts[:headers] = headers
+
+      opts
+    end
+
+    def request(method, options = {})
+      url     = options.fetch(:url)
+      params  = options[:params] || {}
+      body    = options[:body]
+      headers = options[:headers]
+
+      @last_response = response = connection.send(method) do |req|
+        req.url(url)
+        req.headers.merge!(headers)
+        req.params.merge!(params)
+        req.body = body
+      end
+      response
+    rescue Faraday::Error::ClientError => e
+      raise PivotalApi::Error.new(e)
+    end
+
+    class Pagination
+      attr_accessor :headers, :total, :limit, :offset, :returned
+
+      def initialize(headers)
+        @headers  = headers
+        @total    = headers['x-tracker-pagination-total'].to_i
+        @limit    = headers['x-tracker-pagination-limit'].to_i
+        @offset   = headers['x-tracker-pagination-offset'].to_i
+        @returned = headers['x-tracker-pagination-returned'].to_i
+
+        # if offset is negative (e.g. Iterations Endpoint).
+        #   For the 'Done' scope, negative numbers can be passed, which
+        #   specifies the number of iterations preceding the 'Current' iteration.
+        # then need to adjust the negative offset to account for a smaller total,
+        #   and set total to zero since we are paginating from -X to 0.
+        if @offset < 0
+          @offset = -@total if @offset.abs > @total
+          @total  = 0
+        end
+      end
+
+      def more?
+        (offset + limit) < total
+      end
+
+      def next_offset
+        offset + limit
+      end
+
+      def next_page_params
+        { limit: limit, offset: next_offset }
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/comments.rb

@@ -0,0 +1,42 @@
+module PivotalApi
+  module Endpoints
+    class Comments
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all(project_id, story_id, params={})
+        data = client.paginate("/projects/#{project_id}/stories/#{story_id}/comments", params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of stories expected' unless data.is_a? Array
+
+        data.map do |story|
+          Resources::Comment.new({ project_id: project_id }.merge(story))
+        end
+      end
+
+      def get(project_id, story_id, id)
+        data = client.get("/projects/#{project_id}/stories/#{story_id}/comments/#{id}").body
+
+        Resources::Comment.new({ project_id: project_id }.merge(data))
+      end
+
+      def create(project_id, story_id, params)
+        data = client.post("/projects/#{project_id}/stories/#{story_id}/comments", params: params).body
+
+        Resources::Comment.new({ project_id: project_id }.merge(data))
+      end
+
+      def update(project_id, story_id, id, params)
+        data = client.put("/projects/#{project_id}/stories/#{story_id}/comments/#{id}", params: params).body
+
+        Resources::Comment.new({ }.merge(data))
+      end
+
+      def delete(project_id, story_id, id)
+        client.delete("/projects/#{project_id}/stories/#{story_id}/comments/#{id}").body
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/epics.rb

@@ -0,0 +1,26 @@
+module PivotalApi
+  module Endpoints
+    class Epics
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all(project_id, params={})
+        data = client.paginate("/projects/#{project_id}/epics", params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of epics expected' unless data.is_a? Array
+
+        data.map do |epic|
+          Resources::Epic.new({ project_id: project_id }.merge(epic))
+        end
+      end
+
+      def get(project_id, id)
+        data = client.get("/projects/#{project_id}/epics/#{id}").body
+
+        Resources::Epic.new({ project_id: project_id }.merge(data))
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/iterations.rb

@@ -0,0 +1,20 @@
+module PivotalApi
+  module Endpoints
+    class Iterations
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all(project_id, params={})
+        data = client.paginate("/projects/#{project_id}/iterations", params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of iterations expected' unless data.is_a? Array
+
+        data.map do |iteration|
+          Resources::Iteration.new({ project_id: project_id }.merge(iteration))
+        end
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/labels.rb

@@ -0,0 +1,36 @@
+module PivotalApi
+  module Endpoints
+    class Labels
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all(project_id, story_id, params={})
+        data = client.paginate("/projects/#{project_id}/stories/#{story_id}/labels", params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of stories expected' unless data.is_a? Array
+
+        data.map do |story|
+          Resources::Label.new({ project_id: project_id }.merge(story))
+        end
+      end
+
+      def create(project_id, story_id, params)
+        data = client.post("/projects/#{project_id}/stories/#{story_id}/labels", params: params).body
+
+        Resources::Label.new({ project_id: project_id }.merge(data))
+      end
+
+      def update(project_id, story_id, id, params)
+        data = client.put("/projects/#{project_id}/stories/#{story_id}/labels/#{id}", params: params).body
+
+        Resources::Label.new({ }.merge(data))
+      end
+
+      def delete(project_id, story_id, id)
+        client.delete("/projects/#{project_id}/stories/#{story_id}/labels/#{id}").body
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/memberships.rb

@@ -0,0 +1,26 @@
+module PivotalApi
+  module Endpoints
+    class Memberships
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all(project_id, params={})
+        data = client.paginate("/projects/#{project_id}/memberships", params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of memberships expected' unless data.is_a? Array
+
+        data.map do |membership|
+          Resources::ProjectMembership.new({ project_id: project_id }.merge(membership))
+        end
+      end
+
+      def get(project_id, id)
+        data = client.get("/projects/#{project_id}/memberships/#{id}").body
+
+        Resources::ProjectMembership.new({ project_id: project_id }.merge(data))
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/projects.rb

@@ -0,0 +1,50 @@
+module PivotalApi
+  module Endpoints
+    class Projects
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # @param [Hash] params
+      # @return [Array[PivotalApi::Resources::Project]]
+      def all(params={})
+        data = client.paginate('/projects', params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of projects expected' unless data.is_a? Array
+
+        data.map { |project| Resources::Project.new({ }.merge(project)) }
+      end
+
+
+      # @param [Hash] params
+      # @return [PivotalApi::Resources::Project]
+      def get(id, params={})
+        # Endpoints::Project.new(self).get(id, params)
+        data = client.get("/projects/#{id}", params: params).body
+
+        Resources::Project.new({ }.merge(data))
+      end
+
+      def epics
+        Endpoints::Epics.new(client)
+      end
+
+      def iterations
+        Endpoints::Iterations.new(client)
+      end
+
+      def stories
+        Endpoints::Stories.new(client)
+      end
+
+      def memberships
+        Endpoints::Memberships.new(client)
+      end
+
+      def webhooks
+        Endpoints::Webhooks.new(client)
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/stories.rb

@@ -0,0 +1,54 @@
+module PivotalApi
+  module Endpoints
+    class Stories
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all(project_id, params={})
+        data = client.paginate("/projects/#{project_id}/stories", params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of stories expected' unless data.is_a? Array
+
+        data.map do |story|
+          Resources::Story.new({ project_id: project_id }.merge(story))
+        end
+      end
+
+      def get(project_id, id)
+        data = client.get("/projects/#{project_id}/stories/#{id}").body
+
+        Resources::Story.new({ project_id: project_id }.merge(data))
+      end
+
+      def create(project_id, params)
+        data = client.post("/projects/#{project_id}/stories", params: params).body
+
+        Resources::Story.new({ }.merge(data))
+      end
+
+      def update(project_id, id, params)
+        data = client.put("/projects/#{project_id}/stories/#{id}", params: params).body
+
+        Resources::Story.new({ }.merge(data))
+      end
+
+      def delete(project_id, id)
+        client.delete("/projects/#{project_id}/stories/#{id}").body
+      end
+
+      def tasks
+        Endpoints::Tasks.new(client)
+      end
+
+      def comments
+        Endpoints::Comments.new(client)
+      end
+
+      def labels
+        Endpoints::Labels.new(client)
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/tasks.rb

@@ -0,0 +1,26 @@
+module PivotalApi
+  module Endpoints
+    class Tasks
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all(project_id, story_id,  params={})
+        data = client.paginate("/projects/#{project_id}/stories/#{story_id}/tasks", params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of tasks expected' unless data.is_a? Array
+
+        data.map do |task|
+          Resources::Task.new({project_id: project_id }.merge(task))
+        end
+      end
+
+      def get(project_id, story_id, id)
+        data = client.get("/projects/#{project_id}/stories/#{story_id}/tasks/#{id}").body
+
+        Resources::Task.new({project_id: project_id }.merge(data))
+      end
+    end
+  end
+end

data/lib/pivotal_api/endpoints/webhooks.rb

@@ -0,0 +1,42 @@
+module PivotalApi
+  module Endpoints
+    class Webhooks
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all(project_id, params={})
+        data = client.paginate("/projects/#{project_id}/webhooks", params: params)
+        raise PivotalApi::Errors::UnexpectedData, 'Array of webhooks expected' unless data.is_a? Array
+
+        data.map do |story|
+          Resources::Webhook.new({ project_id: project_id }.merge(story))
+        end
+      end
+
+      def get(project_id, id)
+        data = client.get("/projects/#{project_id}/webhooks/#{id}").body
+
+        Resources::Webhook.new({ project_id: project_id }.merge(data))
+      end
+
+      def create(project_id, params)
+        data = client.post("/projects/#{project_id}/webhooks", params: params).body
+
+        Resources::Webhook.new({ }.merge(data))
+      end
+
+      def update(project_id, id, params)
+        data = client.put("/projects/#{project_id}/webhooks/#{id}", params: params).body
+
+        Resources::Webhook.new({ }.merge(data))
+      end
+
+      def delete(project_id, id)
+        client.delete("/projects/#{project_id}/webhooks/#{id}").body
+      end
+    end
+  end
+end

data/lib/pivotal_api/error.rb

@@ -0,0 +1,18 @@
+module PivotalApi
+  class Error < StandardError
+    attr_reader :wrapped_exception, :response
+
+    def initialize(wrapped_exception)
+      @wrapped_exception = wrapped_exception
+      @response          = wrapped_exception.response
+      message            = if wrapped_exception.is_a?(Faraday::Error::ParsingError)
+                             wrapped_exception.message
+                           elsif wrapped_exception.is_a?(Faraday::Error::ClientError)
+                             wrapped_exception.response.inspect
+                           else
+                             wrapped_exception.instance_variable_get(:@wrapped_exception).inspect
+                           end
+      super(message)
+    end
+  end
+end

data/lib/pivotal_api/logger.rb

@@ -0,0 +1,31 @@
+module PivotalApi
+  class Logger < Faraday::Response::Middleware
+    extend Forwardable
+
+    def initialize(app, logger = nil)
+      super(app)
+      @logger = logger || ::Logger.new(STDOUT)
+    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("#{env[:status]} <= #{env[:url].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
+end

data/lib/pivotal_api/resources/account.rb

@@ -0,0 +1,18 @@
+module PivotalApi
+  module Resources
+    class Account
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :created_at, DateTime
+      attribute :status, String
+      attribute :kind, String
+      attribute :name, String
+      attribute :updated_at, DateTime
+      attribute :url, String
+      attribute :plan, String
+      attribute :days_left, Integer
+      attribute :over_the_limit, Boolean
+    end
+  end
+end

data/lib/pivotal_api/resources/comment.rb

@@ -0,0 +1,20 @@
+module PivotalApi
+  module Resources
+    class Comment
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :story_id, Integer
+      attribute :epic_id, Integer
+      attribute :text, String
+      attribute :person_id, Integer
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :file_attachment_ids, Array[Integer]
+      attribute :google_attachment_ids, Array[Integer]
+      attribute :commit_identifier, String
+      attribute :commit_type, String
+      attribute :kind, String
+    end
+  end
+end

data/lib/pivotal_api/resources/epic.rb

@@ -0,0 +1,19 @@
+module PivotalApi
+  module Resources
+    class Epic
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :id, Integer
+      attribute :created_at, DateTime
+      attribute :description, String
+      attribute :kind, String
+      attribute :label, PivotalApi::Resources::Label
+      attribute :name, String
+      attribute :project_id, Integer
+      attribute :updated_at, DateTime
+      attribute :url, String
+    end
+  end
+end

data/lib/pivotal_api/resources/iteration.rb

@@ -0,0 +1,20 @@
+module PivotalApi
+  module Resources
+    class Iteration
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :finish, DateTime
+      attribute :kind, String
+      attribute :length, Integer
+      attribute :number, Integer
+      attribute :planned, Boolean
+      attribute :project_id, Integer
+      attribute :start, DateTime
+      attribute :stories, [PivotalApi::Resources::Story]
+      attribute :story_ids, [Integer]
+      attribute :team_strength, Float
+    end
+  end
+end

data/lib/pivotal_api/resources/label.rb

@@ -0,0 +1,14 @@
+module PivotalApi
+  module Resources
+    class Label
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :created_at, DateTime
+      attribute :kind, String
+      attribute :name, String
+      attribute :project_id, Integer
+      attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/pivotal_api/resources/me.rb

@@ -0,0 +1,23 @@
+module PivotalApi
+  module Resources
+    class Me
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :id, Integer
+      attribute :name, String
+      attribute :initials, String
+      attribute :username, String
+      attribute :time_zone, PivotalApi::Resources::TimeZone
+      attribute :api_token, String
+      attribute :has_google_identity, Boolean
+      attribute :project_ids, Array[Integer]
+      attribute :projects, [PivotalApi::Resources::MembershipSummary]
+      attribute :workspace_ids, Array[Integer]
+      attribute :email, String
+      attribute :receives_in_app_notifications, Boolean
+      attribute :kind, String
+    end
+  end
+end

data/lib/pivotal_api/resources/membership_summary.rb

@@ -0,0 +1,17 @@
+module PivotalApi
+  module Resources
+    class MembershipSummary
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :id, Integer
+      attribute :kind, String
+      attribute :last_viewed_at, DateTime
+      attribute :project_color, String
+      attribute :project_id, Integer
+      attribute :project_name, String
+      attribute :role, String
+    end
+  end
+end

data/lib/pivotal_api/resources/person.rb

@@ -0,0 +1,16 @@
+module PivotalApi
+  module Resources
+    class Person
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :kind, String
+      attribute :id, Integer
+      attribute :name, String
+      attribute :email, String
+      attribute :initials, String
+      attribute :username, String
+    end
+  end
+end

data/lib/pivotal_api/resources/project.rb

@@ -0,0 +1,49 @@
+module PivotalApi
+  module Resources
+    class Project
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :account, PivotalApi::Resources::Account
+      attribute :account_id, Integer
+      attribute :atom_enabled, Boolean
+      attribute :bugs_and_chores_are_estimatable, Boolean
+      attribute :created_at, DateTime
+      attribute :current_iteration_number, Integer
+      attribute :current_velocity, Integer
+      attribute :description, String
+      attribute :enable_following, Boolean
+      attribute :enable_incoming_emails, Boolean
+      attribute :enable_planned_mode, Boolean
+      attribute :enable_tasks, Boolean
+      attribute :epic_ids, Array[Integer]
+      attribute :epics, Array[PivotalApi::Resources::Epic]
+      attribute :has_google_domain, Boolean
+      attribute :id, Integer
+      attribute :initial_velocity, Integer
+      attribute :iteration_length, Integer
+      attribute :kind, String
+      attribute :label_ids, Array[Integer]
+      attribute :labels, Array[PivotalApi::Resources::Label]
+      attribute :name, String
+      attribute :number_of_done_iterations_to_show, Integer
+      attribute :point_scale, String
+      attribute :point_scale_is_custom, Boolean
+      attribute :profile_content, String
+      attribute :public, Boolean
+      attribute :start_date, DateTime
+      attribute :start_time, DateTime
+      attribute :time_zone, PivotalApi::Resources::TimeZone
+      attribute :updated_at, DateTime
+      attribute :velocity_averaged_over, Integer
+      attribute :version, Integer
+      attribute :week_start_day, String
+
+      # @return [String] comma separated list of labels
+      def label_list
+        @label_list ||= labels.collect(&:name).join(',')
+      end
+    end
+  end
+end

data/lib/pivotal_api/resources/project_membership.rb

@@ -0,0 +1,18 @@
+module PivotalApi
+  module Resources
+    class ProjectMembership
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :id, Integer
+      attribute :person_id, Integer
+      attribute :project_id, Integer
+      attribute :role, String
+      attribute :project_color, String
+      attribute :wants_comment_notification_emails, Boolean
+      attribute :kind, String
+      attribute :person, PivotalApi::Resources::Person
+    end
+  end
+end

data/lib/pivotal_api/resources/story.rb

@@ -0,0 +1,41 @@
+module PivotalApi
+  module Resources
+    class Story
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :accepted_at, DateTime
+      attribute :comment_ids, Array[Integer]
+      attribute :created_at, DateTime
+      attribute :current_state, String # (accepted, delivered, finished, started, rejected, planned, unstarted, unscheduled)
+      attribute :deadline, DateTime
+      attribute :description, String
+      attribute :estimate, Float
+      attribute :external_id, String
+      attribute :follower_ids, Array[Integer]
+      attribute :id, Integer
+      attribute :integration_id, Integer
+      attribute :kind, String
+      attribute :label_ids, Array[Integer]
+      attribute :labels, Array[PivotalApi::Resources::Label]
+      attribute :name, String
+      attribute :owned_by_id, Integer # deprecated!
+      attribute :owner_ids, Array[Integer]
+      attribute :owners, Array[PivotalApi::Resources::Person]
+      attribute :planned_iteration_number, Integer
+      attribute :project_id, Integer
+      attribute :requested_by_id, Integer
+      attribute :story_type, String # (feature, bug, chore, release)
+      attribute :task_ids, Array[Integer]
+      attribute :tasks, Array[PivotalApi::Resources::Task]
+      attribute :updated_at, DateTime
+      attribute :url, String
+
+      # @return [String] Comma separated list of labels.
+      def label_list
+        @label_list ||= labels.collect(&:name).join(',')
+      end
+    end
+  end
+end

data/lib/pivotal_api/resources/task.rb

@@ -0,0 +1,19 @@
+module PivotalApi
+  module Resources
+    class Task
+      include Virtus.model
+
+      # attribute :client
+
+      attribute :id, Integer
+      attribute :story_id, Integer
+      attribute :project_id, Integer
+      attribute :description, String
+      attribute :complete, Boolean
+      attribute :position, Integer
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :kind, String
+    end
+  end
+end

data/lib/pivotal_api/resources/time_zone.rb

@@ -0,0 +1,13 @@
+module PivotalApi
+  module Resources
+    class TimeZone
+      include Virtus.value_object
+
+      values do
+        attribute :offset, String
+        attribute :olson_name, String
+        attribute :kind, String
+      end
+    end
+  end
+end

data/lib/pivotal_api/resources/webhook.rb

@@ -0,0 +1,16 @@
+module PivotalApi
+  module Resources
+    class Webhook
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :project_id, Integer
+      attribute :webhook_url, String
+      attribute :webhook_version, String, default: 'v5'
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :kind, String
+
+    end
+  end
+end

data/lib/pivotal_api/version.rb

@@ -0,0 +1,3 @@
+module PivotalApi
+  VERSION = '0.3.1'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: pivotal-api
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Maciej Skierkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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: 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  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: This gem allows you to easily use the Pivotal Tracker v5 API.
+email:
+- maciej@factor.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/pivotal-api.rb"
+- "./lib/pivotal_api/client.rb"
+- "./lib/pivotal_api/endpoints/comments.rb"
+- "./lib/pivotal_api/endpoints/epics.rb"
+- "./lib/pivotal_api/endpoints/iterations.rb"
+- "./lib/pivotal_api/endpoints/labels.rb"
+- "./lib/pivotal_api/endpoints/memberships.rb"
+- "./lib/pivotal_api/endpoints/projects.rb"
+- "./lib/pivotal_api/endpoints/stories.rb"
+- "./lib/pivotal_api/endpoints/tasks.rb"
+- "./lib/pivotal_api/endpoints/webhooks.rb"
+- "./lib/pivotal_api/error.rb"
+- "./lib/pivotal_api/logger.rb"
+- "./lib/pivotal_api/resources/account.rb"
+- "./lib/pivotal_api/resources/comment.rb"
+- "./lib/pivotal_api/resources/epic.rb"
+- "./lib/pivotal_api/resources/iteration.rb"
+- "./lib/pivotal_api/resources/label.rb"
+- "./lib/pivotal_api/resources/me.rb"
+- "./lib/pivotal_api/resources/membership_summary.rb"
+- "./lib/pivotal_api/resources/person.rb"
+- "./lib/pivotal_api/resources/project.rb"
+- "./lib/pivotal_api/resources/project_membership.rb"
+- "./lib/pivotal_api/resources/story.rb"
+- "./lib/pivotal_api/resources/task.rb"
+- "./lib/pivotal_api/resources/time_zone.rb"
+- "./lib/pivotal_api/resources/webhook.rb"
+- "./lib/pivotal_api/version.rb"
+homepage: https://github.com/factor-io/pivotal-api
+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: API client for the Pivotal Tracker v5 API
+test_files: []
+has_rdoc: