kanbantastic 0.1.5

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-1.9.2-p180@kanbantastic

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in kanbantastic.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    kanbantastic (0.1.1)
+      activemodel
+      httparty
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.5)
+    builder (2.1.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    httparty (0.7.4)
+      crack (= 0.1.8)
+    i18n (0.5.0)
+    mocha (0.9.12)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    vcr (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  kanbantastic!
+  mocha
+  rspec
+  vcr

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jagdeep Singh
+
+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
+NON-INFRINGEMENT. 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/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run all rspec examples"
+task :spec do
+  system "rspec spec"
+end

data/kanbantastic.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kanbantastic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kanbantastic"
+  s.version     = Kanbantastic::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jagdeep Singh"]
+  s.email       = ["jagdeepkh@gmail.com"]
+  s.homepage    = "https://github.com/Ennova/Kanbantastic"
+  s.summary     = %q{Provides a ruby interface to manage your kanbanery resources like a project's tasks, columns and more}
+  s.description = %q{Use this gem to interact with kanbanery API}
+
+  s.rubyforge_project = "kanbantastic"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.licenses = ["MIT"]
+  s.rubygems_version = %q{1.3.7}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+
+  s.add_runtime_dependency('activemodel')
+  s.add_runtime_dependency('httparty')
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('fakeweb')
+  s.add_development_dependency('vcr')
+  s.add_development_dependency('mocha')
+end

data/lib/kanbantastic.rb

@@ -0,0 +1,8 @@
+require 'active_model'
+require 'httparty'
+
+require File.join(File.dirname(__FILE__), 'kanbantastic/base')
+require File.join(File.dirname(__FILE__), 'kanbantastic/task')
+require File.join(File.dirname(__FILE__), 'kanbantastic/column')
+require File.join(File.dirname(__FILE__), 'kanbantastic/config')
+require File.join(File.dirname(__FILE__), 'kanbantastic/user')

data/lib/kanbantastic/base.rb

@@ -0,0 +1,140 @@
+module Kanbantastic
+
+  class Base
+    include HTTParty
+    include ActiveModel::Validations
+    validates_presence_of :config
+
+    RECTIFY_TIME_FOR = [:updated_at, :created_at, :moved_at]
+
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+      self.valid?
+    end
+
+    def get(url, options={})
+      check_parameter_format(:url => [url, String], :options => [options, Hash])
+
+      self.class.setup_headers(config.api_key)
+      response = self.class.get(self.class.base_uri(config.workspace) + url, options)
+      if response.code == 200
+        self.class.parse_response(response)
+      else
+        raise response.headers['status']
+      end
+    end
+
+    def post(url, options={})
+      check_parameter_format(:url => [url, String], :options => [options, Hash])
+
+      self.class.setup_headers(config.api_key)
+      response = self.class.post(self.class.base_uri(config.workspace) + url, options)
+      if response.code == 201
+        self.class.parse_response(response)
+      else
+        raise response.headers['status']
+      end
+    end
+
+    def put(url, options={})
+      check_parameter_format(:url => [url, String], :options => [options, Hash])
+
+      self.class.setup_headers(config.api_key)
+      response = self.class.put(self.class.base_uri(config.workspace) + url, options)
+      if response.code == 200
+        self.class.parse_response(response)
+      else
+        raise response.headers['status']
+      end
+    end
+
+    def project_id
+      config.project_id
+    end
+
+    def assign_attributes(params={})
+      params.each do |key, value|
+        method_name = key.to_s+"="
+        self.send(method_name, value) if self.respond_to?(method_name)
+      end
+      return self
+    end
+
+    def self.find_project_id(project_name, workspace_name, api_key)
+      setup_headers(api_key)
+      workspaces = get(base_uri(workspace_name) + "/user/workspaces.json").parsed_response
+      if workspace_name
+        workspace = workspaces.select{|w| w['name'] == workspace_name }.first
+        project = workspace['projects'].select{|p| p['name'] == project_name }.first if workspace
+      end
+      return project['id'] if project
+    end
+
+    def self.request(method, config, url, options={})
+      new(config).send(method.to_s, url, options)
+    end
+
+    def self.invalid_response_error(msg, response)
+      begin
+        text = response.map{|k,v| v.map{|e| "#{k} #{e}" }.join(', ')}.join(', ')
+      rescue
+        raise msg
+      end
+      raise "#{msg} #{text}"
+    end
+
+    private
+
+    def self.parse_response response
+      rectify_time(symbolize_keys(response.parsed_response))
+    end
+
+    def self.rectify_time response
+      diff = server_time_difference
+      if response.class == Array
+        response.each{|r| RECTIFY_TIME_FOR.each{|k| (r[k] += diff) if r[k]}}
+      else
+        RECTIFY_TIME_FOR.each{|k| (response[k] += diff) if response[k]}
+      end
+      return response
+    end
+
+    def self.server_time_difference
+      diff = (Time.now.utc.to_i - Time.parse(head("https://kanbanery.com/api/v1/test.json").headers['date']).utc.to_i)
+      if diff > 1
+        raise "Kanbanery server has a time difference of #{diff} seconds"
+      else
+        return diff
+      end
+    end
+
+    def check_parameter_format options={}
+      raise "options must be a Hash" unless options.instance_of?(Hash)
+      options.each do |key, value|
+        raise "options Hash must have each key as a Symbol or a String" unless key.instance_of?(Symbol) or key.instance_of?(String)
+        if value.class != Array or value.length != 2 or value[1].class != Class
+          raise "each value of options Hash must be an Array of a parameter and its expected class."
+        end
+        raise "#{key} must be a #{value[1]}." unless value[0].instance_of? value[1]
+      end
+    end
+
+    def self.base_uri workspace
+      "https://#{workspace}.kanbanery.com/api/v1"
+    end
+
+    def self.setup_headers api_key
+      headers['X-Kanbanery-ApiToken'] = api_key
+    end
+
+    def self.symbolize_keys(hsh)
+      if hsh.class == Array
+        hsh.map{|x| x.inject({}){|h,(k,v)| h[k.to_sym] = v; h}}
+      else
+        hsh.inject({}){|h,(k,v)| h[k.to_sym] = v; h}
+      end
+    end
+  end
+end

data/lib/kanbantastic/column.rb

@@ -0,0 +1,45 @@
+module Kanbantastic
+
+  class Column < Base
+    attr_reader :id, :name, :position
+    validates_presence_of :id, :name, :position
+
+    def initialize(config, options={})
+      super(config)
+      @id = options[:id]
+      @name = options[:name]
+      @position = options[:position]
+      self.valid?
+    end
+
+    def first?
+      self.position == 1
+    end
+
+    def second?
+      self.position == 2
+    end
+
+    def last?
+      Kanbantastic::Column.all(config).last.id == id
+    end
+
+    def ==(column)
+      id == column.id
+    end
+
+    def self.find(config, id)
+      Kanbantastic::Column.all(config).select{|c| c.id == id }[0]
+    end
+
+    def self.all(config)
+      collection = []
+      response = request(:get, config, "/projects/#{config.project_id}/columns.json")
+      response.each do |data|
+        column = new(config, data)
+        collection << column if column.valid?
+      end
+      return collection
+    end
+  end
+end

data/lib/kanbantastic/config.rb

@@ -0,0 +1,15 @@
+module Kanbantastic
+
+  class Config
+    include ActiveModel::Validations
+    attr_reader :api_key, :workspace, :project_id
+    validates_presence_of :api_key, :workspace, :project_id
+
+    def initialize(api_key, workspace, project_id)
+      @api_key = api_key
+      @workspace = workspace
+      @project_id = project_id
+      self.valid?
+    end
+  end
+end

data/lib/kanbantastic/task.rb

@@ -0,0 +1,130 @@
+module Kanbantastic
+
+  class Task < Base
+    attr_accessor :id, :title, :column_id, :updated_at, :created_at, :moved_at, :task_type_id, :owner_id, :position
+    validates_presence_of :config, :id, :title, :column_id, :updated_at, :task_type_id
+
+    def initialize(config, options = {})
+      super(config)
+      assign_attributes(options)
+      @task_type_id = options[:task_type_id] || find_task_type_id(options[:task_type_name])
+      valid?
+    end
+
+    def find_task_type_id(task_type_name)
+      @task_type_ids ||= {}
+      @task_type_ids[task_type_name] ||= if !task_type_name.blank?
+        response = get("/projects/#{project_id}/task_types.json")
+        task_type = response.select{|t| t[:name] == task_type_name}.first || Hash.new
+        task_type[:id]
+      end
+    end
+
+    def update(params={})
+      params[:owner_id] ||= self.owner_id
+      begin
+        response = put("/tasks/#{id}.json", :body => {:task => params})
+      rescue Exception => e
+        self.class.invalid_response_error("Unable to update task. #{e.message}", response)
+      end
+      if response[:id]
+        assign_attributes(response)
+        return valid?
+      else
+        self.class.invalid_response_error("Unable to update task.", response)
+      end
+    end
+
+    def self.create(config, params={})
+      # raise exception if title and task_type_name is not present
+      unless params[:title] and params[:task_type_name]
+        raise "Kanbanery task can't be created without title and task_type_name."
+      end
+      response = request(:post, config, "/projects/#{config.project_id}/tasks.json", :body => {:task => params})
+      task = new(config, response)
+      task.valid? ? task : invalid_response_error("Unable to create task.", response)
+    end
+
+    def column
+      @columns ||= {}
+      @columns[column_id] ||= Kanbantastic::Column.find(config, column_id)
+    end
+
+    def move_to_next_column
+      update(:location => 'next_column')
+    end
+
+    def move_to_previous_column
+      update(:location => 'prev_column')
+    end
+
+    def move_to_first_column
+      column = Kanbantastic::Column.all(config).first
+      update(:column_id => column.id, :position => nil)
+    end
+
+    def move_to_second_column
+      column = Kanbantastic::Column.all(config)[1]
+      update(:column_id => column.id, :position => nil)
+    end
+
+    def move_to_last_column
+      column = Kanbantastic::Column.all(config).last
+      update(:column_id => column.id, :position => nil)
+    end
+
+    def archive
+      if Kanbantastic::Task.archived?(config, id)
+        return true
+      else
+        # raise an exception as only tasks which are in last column can be archived.
+        unless column.last?
+          raise "Kanbanery tasks can be archived only from the last column."
+        end
+        update(:location => "archive")
+      end
+    end
+
+    def owner
+      @owner ||= if owner_id
+        response = get("/projects/#{project_id}/users.json")
+        user = response.select{|r| r[:id] == owner_id}[0]
+        Kanbantastic::User.new("#{user[:first_name]} #{user[:last_name]}", user[:email], user[:gravatar_url])
+      end
+    end
+
+    def ==(task)
+      id == task.id
+    end
+
+    def self.archived?(config, id)
+      response = request(:get, config, "/projects/#{config.project_id}/archive/tasks.json")
+      archived_task = response.select{|t| t[:id] == id}[0]
+      archived_task ? true : false
+    end
+
+    def self.find(config, id)
+      begin
+        response = request(:get, config, "/tasks/#{id}.json")
+      rescue
+        return nil
+      end
+      task = new(config, response)
+      if task.valid?
+        return task
+      else
+        return nil
+      end
+    end
+
+    def self.all(config)
+      collection = []
+      response = request(:get, config, "/projects/#{config.project_id}/tasks.json")
+      response.each do |data|
+        task = self.new(config, data)
+        collection << task if task.valid?
+      end
+      return collection
+    end
+  end
+end