teamwork_scrape_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 337bf53ee7e80e200b3368492fb654d0c95709f9
+  data.tar.gz: 5786ea834eab1ff0b1734e92faf7d166a2e03df4
+SHA512:
+  metadata.gz: 7337492ffc3f8fb7c66827a50d6fd0250215fa55faa04330dce088565379f0601ef8c832fc1d5444190d993b4992fbe0275ae053b6df0ae3e9bf8114566efdb7
+  data.tar.gz: f5ea4bf1ed4eda4b10e9a9c07cdcd781e3d4991777c4cf381e8b2416f06ff62ebfb49b2eb669b5891fdb9455c201ce9517a212e6ceced77a27e50e9537cc5049

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eric Mason
+
+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,49 @@
+# TeamworkScrapeClient
+
+Unofficial Teamwork.com scraping client to supplement the official API. Provides the ability to copy projects.
+
+**WARNING:** This library uses undocumented APIs intended for use by the Teamwork.com web interface to communicate with the server. If they change the API, this library may break.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'teamwork_scrape_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teamwork_scrape_client
+
+## Usage
+
+```ruby
+client = TeamworkScrapeClient::Client.new(
+  email: 'youremail@example.com', 
+  password: 'secret_password', 
+  base_url: 'https://yourdomain.teamwork.com'
+)
+
+client.copy_project(old_project_id: 12345, new_company_name: "Test Company", new_project_name: "Test Project")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ericmason/teamwork_scrape_client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "teamwork_scrape_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/teamwork_scrape_client/client.rb

@@ -0,0 +1,117 @@
+require 'mechanize'
+require 'json'
+
+module TeamworkScrapeClient
+  class Client
+    attr_reader :base_url, :email, :password
+
+    def initialize(options = {})
+      @email = options[:email]
+      @password = options[:password]
+      @base_url = options[:base_url]
+
+      raise ArgumentError, 'email is required' unless @email
+      raise ArgumentError, 'password is required' unless @password
+      raise ArgumentError, 'base_url is required' unless @base_url
+
+      login(email, password)
+    end
+
+    def mech
+      @mech ||= Mechanize.new do |m|
+        m.log = Logger.new(STDOUT)
+      end
+    end
+
+    def login(email, password)
+      mech.post(
+        "#{base_url}/v/1/login.json?getInitialPage=true",
+        { username: email, password: password, rememberMe: false }.to_json,
+        { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def profile
+      response = mech.get('/me.json',
+                          fullprofile: 1,
+                          getPreferences: 1,
+                          cleanPreferences: true,
+                          getAccounts: 1,
+                          includeAuth: 1,
+                          includeClockIn: 1)
+      JSON.parse(response.body)['profile']
+    end
+
+    def account
+      return @account if @account
+      response = mech.get('/account.json')
+      @account = JSON.parse(response.body)['account']
+    end
+
+    def project(id)
+      response = mech.get("/projects/#{id}.json?getPermissions=true&getNotificationSettings=true&getActivePages=true&getDateInfo=true&getEmailAddress=true&formatMarkdown=false")
+      Project.new(JSON.parse(response.body)['project'])
+    end
+
+    def company_by_name(company_name)
+      response = mech.get("/projects.json?getActivePages=true&searchCompany=true&formatMarkdown=false&status=active&getCategoryPath=1&userId=0&page=1&pageSize=500&orderBy=lastActivityDate&orderMode=DESC")
+      projects = JSON.parse(response.body)['projects']
+      companies = projects.map { |p| p['company'] }.uniq
+      companies.find { |c| c['name'] == company_name }
+    end
+
+    def project_by_name(project_name)
+      response = mech.get("/projects.json?getActivePages=true&searchCompany=true&formatMarkdown=false&status=active&getCategoryPath=1&userId=0&page=1&pageSize=500&orderBy=lastActivityDate&orderMode=DESC")
+      JSON.parse(response.body)['projects']
+    end
+
+    def copy_project(options = {})
+      old_project_id = options[:old_project_id]
+      raise ArgumentError, "old_project_id option is required" unless old_project_id
+
+      new_project_name = options[:new_project_name]
+      raise ArgumentError, "new_project_name option is required" unless new_project_name
+
+      new_company_name = options[:new_company_name]
+      raise ArgumentError, "new_company_name option is required" unless new_company_name
+
+      # Find an existing company or add a new one
+      existing_company = company_by_name(new_company_name)
+      existing_company_id = existing_company ? existing_company['id'] : nil
+
+      old_project = project(old_project_id)
+
+      response = mech.post(
+        '/index.cfm',
+        action: 'CloneProject_CreateProjectClone',
+        id: old_project_id,
+        installationId: account['id'],
+        'cloneproject-action' => 'copy',
+        cloneProjectName: new_project_name,
+        copyTasks: 'YES',
+        copyMilestones: 'YES',
+        copyMessages: 'YES',
+        copyFiles: 'YES',
+        copyLinks: 'YES',
+        copyNotebooks: 'YES',
+        copyTimelogs: 'YES',
+        copyInvoices: 'YES',
+        copyExpenses: 'YES',
+        copyRisks: 'YES',
+        copyPeople: 'YES',
+        daysOffset: old_project.days_offset,
+        keepOffWeekends: '1',
+        createActivityLog: 'YES',
+        createItemsUsingCurrentUser: 'NO',
+        uncomplete: 'YES',
+        copyComments: 'YES',
+        copyProjectRoles: 'YES',
+        copyLogo: 'YES',
+        companyId: existing_company_id || 0,
+        newCompanyName: existing_company_id ? '' : new_company_name
+      )
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/teamwork_scrape_client/project.rb

@@ -0,0 +1,22 @@
+module TeamworkScrapeClient
+  class Project
+    attr_accessor :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def [](key)
+      attributes[key]
+    end
+
+    def start_date
+      Date.parse(attributes['startDate'])
+    end
+
+    # Returns the date offset needed when using this project as a template
+    def days_offset
+      (Date.today - start_date).to_i
+    end
+  end
+end

data/lib/teamwork_scrape_client/version.rb

@@ -0,0 +1,3 @@
+module TeamworkScrapeClient
+  VERSION = "0.1.0"
+end

data/lib/teamwork_scrape_client.rb

@@ -0,0 +1,6 @@
+require 'teamwork_scrape_client/version'
+require 'teamwork_scrape_client/client'
+require 'teamwork_scrape_client/project'
+
+module TeamworkScrapeClient
+end

data/teamwork_scrape_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'teamwork_scrape_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "teamwork_scrape_client"
+  spec.version       = TeamworkScrapeClient::VERSION
+  spec.authors       = ["Eric Mason"]
+  spec.email         = ["eric@equisolve.com"]
+
+  spec.summary       = %q{Unofficial Teamwork.com scraping client to supplement the official API}
+  spec.description   = %q{Unofficial Teamwork.com scraping client to supplement the official API. Provides the ability to copy projects.}
+  spec.homepage      = "https://github.com/ericmason/equisolve-teamwork_scrape_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'mechanize', '~> 2.7'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: teamwork_scrape_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Mason
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Unofficial Teamwork.com scraping client to supplement the official API.
+  Provides the ability to copy projects.
+email:
+- eric@equisolve.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/teamwork_scrape_client.rb
+- lib/teamwork_scrape_client/client.rb
+- lib/teamwork_scrape_client/project.rb
+- lib/teamwork_scrape_client/version.rb
+- teamwork_scrape_client.gemspec
+homepage: https://github.com/ericmason/equisolve-teamwork_scrape_client
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Unofficial Teamwork.com scraping client to supplement the official API
+test_files: []