acuforce 0.2.0

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+#gem 'psych'
+gem 'mechanize'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Harrison Strowd
+
+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.rdoc

@@ -0,0 +1,27 @@
+= AcuForce
+
+Gem that handles integration with Acunote. Does not expose all actions at this time.
+
+Current actions supported:
+ - Logging in and Logging out
+ - Creating a sprint
+ - Finding a sprint
+ - Uploading tasks to a sprint from a CSV file
+ - Exporting tasks in a sprint to a CSV file
+
+== Contributing to AcuForce
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Harrison Strowd. See LICENSE.txt for
+further details.
+
+This work was forked and redesigned from work done by bfeigin in https://github.com/bfeigin/AcuPlan.

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "acuforce"
+  gem.homepage = "http://github.com/hstrowd/AcuForce"
+  gem.license = "MIT"
+  gem.summary = %Q{Client API for performing actions on an Acunote site.}
+  gem.description = %Q{
+Provides an API for the following actions:
+* Logging in and Logging out
+* Creating a sprint
+* Finding a sprint
+* Uploading tasks to a sprint from a CSV file
+* Exporting tasks in a sprint to a CSV file
+}
+  gem.email = "hstrowd@gmail.com"
+  gem.authors = ["Harrison Strowd"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acuforce #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/acuforce.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acuforce}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Harrison Strowd"]
+  s.date = %q{2011-12-24}
+  s.description = %q{
+Provides an API for the following actions:
+* Logging in and Logging out
+* Creating a sprint
+* Finding a sprint
+* Uploading tasks to a sprint from a CSV file
+* Exporting tasks in a sprint to a CSV file
+}
+  s.email = %q{hstrowd@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "acuforce.gemspec",
+    "lib/acuforce.rb",
+    "lib/acunote_connection.rb",
+    "lib/acunote_project.rb",
+    "lib/acunote_sprint.rb",
+    "spec/acuforce_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/hstrowd/AcuForce}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Client API for performing actions on an Acunote site.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mechanize>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<mechanize>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mechanize>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/acuforce.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#INITAL DEVELOPMENT
+#askryl
+#https://github.com/skryl/AcuForce.git
+
+#bfeigin intense modifications
+#Ripped out most of AcuForce, kept the basic Acunote logic see AcunoteBase
+#https://github.com/bfeigin/AcuForce.git
+
+#Major modifications to transition from OmniPlan to Accunote
+#Notes there are a few gems required see directly below :)
+
+require 'rubygems'
+require 'acunote_connection'
+require 'acunote_project'
+require 'acunote_sprint'
+
+DEBUG = true unless defined? DEBUG

data/lib/acunote_connection.rb

@@ -0,0 +1,113 @@
+require 'mechanize'
+require 'yaml'
+require 'singleton'
+
+# A singleton class to contain the acunote session information.
+class AcunoteConnection
+  include Singleton
+
+  attr_accessor :username
+  attr_writer :home_url
+  attr_reader :logged_in, :mech
+
+  def initialize()
+    @mech ||= Mechanize.new
+  end
+
+  # For lack of a better place, put sessions in tmp
+  SESSION_DIR = "/tmp" unless defined? SESSION_DIR
+  SESSION_FILE = "#{SESSION_DIR}/acunote.session" unless defined? SESSION_FILE
+
+  LOGIN_FIELDS = ['login[username]', 'login[password]'] unless defined? LOGIN_FIELDS
+  LOGIN_FORM_NAME = "login_form" unless defined? LOGIN_FORM_NAME
+
+  # The home_url must be set after the instance is first retrieved.
+  def home_url
+    raise "home_url not set" unless @home_url
+    @home_url
+  end
+
+  def login_url
+    "#{self.home_url}/login"
+  end
+
+  def logout_url
+    "#{self.home_url}/login/logout"
+  end
+
+  def login(username, password, force = false)
+    @logged_in = nil if force
+    return true if logged_in
+
+    #Going to assume the session is good to save time here. The session will be
+    #discarded and a force login will be performed if get_page fails.
+    if !force && File.exists?(SESSION_FILE) && ! File.zero?(SESSION_FILE) && mech.cookie_jar.load(SESSION_FILE)
+      STDERR.puts "Loaded session file" if DEBUG
+      @username = username
+      @logged_in = true
+    end
+
+    unless logged_in
+
+      #try to log in
+      login_page = get_page(login_url)
+      STDERR.puts "Navigated to '#{login_page.title}'" if DEBUG
+
+      form = login_page.forms.first
+      form[LOGIN_FIELDS[0]] = username
+      form[LOGIN_FIELDS[1]] = password
+      dest_page = form.submit(form.buttons.first)
+
+      STDERR.puts "Navigated to '#{dest_page.title}'" if DEBUG
+      if dest_page.uri == login_page.uri
+        STDERR.puts "Error: Bad login!"
+        return false
+      end
+
+      #serialize session and save for later reuse
+      mech.cookie_jar.save_as(SESSION_FILE)
+      @username = username
+      @logged_in = true
+    end
+  end
+
+  def logout()
+    if File.exists?(SESSION_FILE)
+      File.delete(SESSION_FILE)
+    end
+    get_page(logout_url)
+    @username = nil
+    @logged_in = false
+  end
+
+  def set_timeout(timeout = 60)
+    mech.keep_alive = false
+    mech.open_timeout = timeout
+    mech.read_timeout = timeout
+    mech.idle_timeout = timeout
+  end
+
+  #Retrieves the requested page and verifies destination url to make sure there
+  #was no innapropriate redirect. If redirected, a force login will be performed
+  #(assuming credentials are passed in as arguments) and the page will be retrieved 
+  #again. 
+  def get_page(url, matcher = /.*/, retry_count = 1)
+    begin
+      page = mech.get(url)
+      if page.uri.to_s =~ matcher
+        page
+      else
+        #try a force login and retry once (in case the session is stale)
+        if retry_count > 0 && login(true)
+          STDERR.puts "Attn: get_page problem, overwrote stale session, retrying..."
+          get_page(url, matcher, retry_count - 1)
+        else STDERR.puts "Error: Can't retrieve valid response page for <#{url}>"
+        end
+      end
+    rescue Mechanize::ResponseCodeError => e
+      STDERR.puts "ResponseError!"
+      puts url if DEBUG
+      puts e if DEBUG
+    end
+  end
+end

data/lib/acunote_project.rb

@@ -0,0 +1,25 @@
+require 'acunote_connection'
+
+# API for accessing Acunote projects.
+class AcunoteProject
+  def self.acu_conn
+    AcunoteConnection.instance
+  end
+
+  def self.url(id)
+    "#{acu_conn.home_url}/projects/#{id}"
+  end
+
+  def self.find_id_by_name(name)
+    link = find_by_name(proj_id, sprint_name)
+    if(link.uri.to_s =~ /projects\/([0-9]*)\/sprints/)
+      $1
+    end
+  end
+
+  # NAME can be a literal string or a regex.
+  def self.find_by_name(name)
+    projects = acu_conn.get_page(url(''))
+    projects.links_with(:href => /projects\/([0-9]*)\/sprints$/, :text => name).first if projects
+  end
+end

data/lib/acunote_sprint.rb

@@ -0,0 +1,71 @@
+require 'acunote_connection'
+
+# API for accessing Acunote projects.
+class AcunoteSprint
+  ACUNOTE_CSV_HEADER = "Level,Number,Description,Tags,Owner,Status,Resolution,Priority,Severity,Estimate,Remaining,Due Date,QA Owner,Business Owner,Wiki,Watchers,Related,Duplicate,Predecessors,Successors,Version 1\r\n" unless defined? ACUNOTE_CSV_HEADER
+
+  def self.acu_conn
+    AcunoteConnection.instance
+  end
+
+  def self.url(proj_id, sprint_id)
+    "#{acu_conn.home_url}/projects/#{proj_id}/sprints/#{sprint_id}"
+  end
+
+  def self.create(proj_id, name, opts = {})
+    opts[:type] ||= 'Backlog'
+    opts[:start_date]  ||= Date.today
+    opts[:end_date]    ||= opts[:start_date] + 365
+
+    unless acu_conn.logged_in
+      STDERR.puts "Must login before creating a sprint." if DEBUG
+      return false
+    end
+
+    sprint_page = acu_conn.get_page(url(proj_id, 'new'))
+
+    # Check that the project could be found.
+    unless sprint_page
+      STDERR.puts "Spcified project could not be found." if DEBUG
+      return false
+    end
+
+    sprint_form = sprint_page.forms_with({:name => 'sprint_new_dialog'}).first
+
+    if opts[:type] == 'Backlog'
+      (sprint_form.radiobuttons_with(:value => /Backlog/).first && 
+      sprint_form.radiobuttons_with(:value => /Backlog/).first.check)
+    else
+      sprint_form.radiobuttons_with(:value => /Iteration/).first.check
+      sprint_form.fields_with(:id => 'sprint_start_date').first.value = opts[:start_date].to_s
+    end
+    sprint_form.fields_with(:id => 'sprint_name').first.value = name
+    sprint_form.fields_with(:id => 'sprint_end_date').first.value = opts[:end_date].to_s
+    sprint_form.submit
+  end
+
+  # NAME can be a literal string or a regex.
+  def self.find_id_by_name(proj_id, name)
+    link = find_by_name(proj_id, name)
+    if(link.uri.to_s =~ /\/sprints\/([0-9]*)/)
+      $1
+    end
+  end
+
+  # NAME can be a literal string or a regex.
+  def self.find_by_name(proj_id, name)
+    sprints = acu_conn.get_page(url(proj_id, ''))
+    sprints.links_with(:text => name).first if sprints
+  end
+
+  def self.upload_csv(raw_data, proj_id, sprint_id)
+    import_page = acu_conn.get_page(url(opts[:proj_id],sprint_id)+"/import")
+    import_form = import_page.form_with({:name => 'import_form'})
+    import_form.field_with(:id => 'data_to_import').value  = raw_data.to_s
+    import_form.submit
+  end
+
+  def self.export_csv(proj_id, sprint_id)
+    acu_conn.get_page(url(proj_id,sprint_id) + '/export').body
+  end
+end

data/spec/acuforce_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Acufore Loading' do
+  it 'should be able to load the Connection API' do
+    AcunoteConnection.should === AcunoteConnection.instance
+  end
+  it 'should be able to load the Project API' do
+    AcunoteProject.should === AcunoteProject.new
+  end
+  it 'should be able to load the Sprint API' do
+    AcunoteSprint.should === AcunoteSprint.new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'acuforce'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: acuforce
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Harrison Strowd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-24 00:00:00.000000000 -06:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: &2156230120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156230120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156229640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156229640
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2156229160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156229160
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2156228680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2156228680
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2156228200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156228200
+description: ! '
+
+  Provides an API for the following actions:
+
+  * Logging in and Logging out
+
+  * Creating a sprint
+
+  * Finding a sprint
+
+  * Uploading tasks to a sprint from a CSV file
+
+  * Exporting tasks in a sprint to a CSV file
+
+'
+email: hstrowd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- acuforce.gemspec
+- lib/acuforce.rb
+- lib/acunote_connection.rb
+- lib/acunote_project.rb
+- lib/acunote_sprint.rb
+- spec/acuforce_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hstrowd/AcuForce
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 102055120518766815
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Client API for performing actions on an Acunote site.
+test_files: []