twigg-pivotal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f07dcc042abc61c5a3f8750f8b7e20fa112896f7
+  data.tar.gz: e0978716cdf21a3c8ad34d47f44a22584a58c4bc
+SHA512:
+  metadata.gz: fa28afa37578ed7171c69c9ba4f7c3cd8d1c6d2022396ac2b7614981f1c25568c890d4f2a5675d70bb290ce2f46da7dbe2843d793b8a195806f75596e90085eb
+  data.tar.gz: 131bf3ee3e512c6630427babef0805ff9e8b46676f472ea9a5d6286b39f45394cac26a214c9ae68864f189d1c4917b75a99a361c1f151a0dbe5026b6ac014373

data/lib/twigg-pivotal.rb

@@ -0,0 +1,10 @@
+require 'twigg'
+require 'twigg/command'
+
+module Twigg
+  autoload :Pivotal, 'twigg-pivotal/pivotal'
+
+  class Command
+    autoload :Pivotal, 'twigg-pivotal/command/pivotal'
+  end
+end

data/lib/twigg-pivotal/command/pivotal.rb

@@ -0,0 +1,53 @@
+module Twigg
+  class Command
+    class Pivotal < Command
+      include Util
+      SUB_SUBCOMMANDS = ['stats']
+
+      def initialize(*args)
+        super
+        @sub_subcommand = @args.shift
+        ignore @args
+
+        unless SUB_SUBCOMMANDS.include?(@sub_subcommand)
+          Help.new('pivotal').run!
+        end
+      end
+
+      def run
+        send @sub_subcommand
+      end
+
+    private
+
+      # Shows a list of open stories, grouped by status.
+      def stats
+        groups = ::Twigg::Pivotal::Status.status
+
+        groups.each do |current_state, stories|
+          header = pluralize stories.size,
+                             "#{current_state} story",
+                             "#{current_state} stories"
+          puts header
+
+          stories.each do |story|
+            print "[#{story.story_type}] #{story.name}"
+            if story.owned_by
+              puts " [#{story.owned_by['initials']}]"
+            else
+              puts
+            end
+          end
+
+          puts
+        end
+
+        puts '', 'Totals'
+        groups.each do |current_state, stories|
+          puts number_with_delimiter(stories.size) + " #{current_state}"
+        end
+        puts
+      end
+    end
+  end
+end

data/lib/twigg-pivotal/pivotal.rb

@@ -0,0 +1,9 @@
+module Twigg
+  module Pivotal
+    autoload :Project,  'twigg-pivotal/pivotal/project'
+    autoload :Resource, 'twigg-pivotal/pivotal/resource'
+    autoload :Status,   'twigg-pivotal/pivotal/status'
+    autoload :Story,    'twigg-pivotal/pivotal/story'
+    autoload :VERSION,  'twigg-pivotal/pivotal/version'
+  end
+end

data/lib/twigg-pivotal/pivotal/project.rb

@@ -0,0 +1,27 @@
+module Twigg
+  module Pivotal
+    # Models the project resource in Pivotal Tracker.
+    class Project < Resource
+      attr_reader :pivotal_id, :name
+
+      class << self
+        # Returns an array of all projects accessible with the configured access
+        # token.
+        def projects
+          results = get 'projects', fields: 'name', paginate: false
+          results.map { |project| new(project) }
+        end
+      end
+
+      def initialize(json)
+        raise ArgumentError unless @pivotal_id = json['id']
+        raise ArgumentError unless @name       = json['name']
+      end
+
+      # Returns the open stories for this project.
+      def stories
+        Story.stories(@pivotal_id)
+      end
+    end
+  end
+end

data/lib/twigg-pivotal/pivotal/resource.rb

@@ -0,0 +1,57 @@
+require 'rest_client'
+require 'json'
+require 'uri'
+
+module Twigg
+  module Pivotal
+    class Resource
+      class << self
+      private
+        PIVOTAL_BASE = 'https://www.pivotaltracker.com/services/v5'
+
+        def get(resource, paginate: true, **params)
+          results = []
+          offset  = paginate ? 0 : nil
+          params  = default_params.merge(params)
+          done    = false
+
+          begin
+            returned = 0
+            url      = "#{PIVOTAL_BASE}/#{resource}"
+            query    = params_to_query(paginate ? params.merge(offset: offset) : params)
+            url << "?#{URI.encode query}"
+
+            response   = RestClient.get url, headers
+            json       = JSON[response]
+
+            if paginate
+              pagination = json['pagination']
+              returned   = pagination['returned']
+              offset     += returned
+
+              if results.size + returned == pagination['total']
+                done = true
+              end
+            end
+
+            results.concat(json['data'])
+          end until returned == 0 || done
+
+          results
+        end
+
+        def default_params
+          { envelope: true }
+        end
+
+        def headers
+          { 'X-TrackerToken' => Config.pivotal.token }
+        end
+
+        def params_to_query(params)
+          params.map { |key, value| "#{key}=#{value}" }.join('&')
+        end
+      end
+    end
+  end
+end

data/lib/twigg-pivotal/pivotal/status.rb

@@ -0,0 +1,17 @@
+module Twigg
+  module Pivotal
+    # This module provides an overview summary of Pivotal Tracker status.
+    #
+    # This is the main entry point for external callers, such as the `twigg`
+    # command-line app and the Twigg web app.
+    module Status
+      class << self
+        def status
+          projects = Project.projects
+          stories  = projects.flat_map(&:stories)
+          stories.group_by(&:current_state)
+        end
+      end
+    end
+  end
+end

data/lib/twigg-pivotal/pivotal/story.rb

@@ -0,0 +1,34 @@
+module Twigg
+  module Pivotal
+    # Models the story resource in Pivotal Tracker.
+    class Story < Resource
+      attr_reader :pivotal_id, :current_state, :story_type, :name, :url,
+        :owned_by
+
+      class << self
+        # Returns an array of all open stories for the project identified by
+        # `project_id`.
+        def stories(project_id)
+          raise ArgumentError, "'project_id' is required" unless project_id
+
+          results = get "projects/#{project_id}/stories",
+            filter: 'state:started,finished,delivered,rejected',
+            fields: 'current_state,story_type,name,url,owned_by'
+
+          results.map { |story| new(story) }
+        end
+      end
+
+      def initialize(json)
+        raise ArgumentError unless @pivotal_id    = json['id']
+        raise ArgumentError unless @current_state = json['current_state']
+        raise ArgumentError unless @story_type    = json['story_type']
+        raise ArgumentError unless @name          = json['name']
+        raise ArgumentError unless @url           = json['url']
+
+        # optional (some stories don't have owners)
+        @owned_by = json['owned_by']
+      end
+    end
+  end
+end

data/lib/twigg-pivotal/pivotal/version.rb

@@ -0,0 +1,5 @@
+module Twigg
+  module Pivotal
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: twigg-pivotal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Causes Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-11 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: rspec
+  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: rest-client
+  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: twigg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+description: Twigg provides stats for activity in Git repositories. This is the adapter
+  that enables Twigg to report on activity occurring inside Pivotal Tracker.
+email:
+- eng@causes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/twigg-pivotal/command/pivotal.rb
+- lib/twigg-pivotal/pivotal/project.rb
+- lib/twigg-pivotal/pivotal/resource.rb
+- lib/twigg-pivotal/pivotal/status.rb
+- lib/twigg-pivotal/pivotal/story.rb
+- lib/twigg-pivotal/pivotal/version.rb
+- lib/twigg-pivotal/pivotal.rb
+- lib/twigg-pivotal.rb
+homepage: https://github.com/causes/twigg
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Pivotal integration for Twigg repo statistics tool
+test_files: []