mavenlink 0.0.1 → 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,3 +1,10 @@
-source 'http://rubygems.org'
-gemspec
-gem 'rake'
+source "http://rubygems.org"
+
+#gemspec
+
+gem "httparty", "0.7.4"
+gem "webmock", "~> 1.6.2"
+gem "rspec", "~> 2.3.0"
+gem "jeweler", "~> 1.5.2"
+gem "rr", "~> 1.0.2"
+gem "json", "~> 1.5.1"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.4)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    httparty (0.7.4)
+      crack (= 0.1.8)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.1)
+    rake (0.8.7)
+    rr (1.0.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty (= 0.7.4)
+  jeweler (~> 1.5.2)
+  json (~> 1.5.1)
+  rr (~> 1.0.2)
+  rspec (~> 2.3.0)
+  webmock (~> 1.6.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mavenlink, LLC.
+
+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,69 @@
+= Mavenlink Ruby API Client
+
+The Mavenlink API provides programmatic access to many of Mavenlink's capabilities, including projects, posts, tasks, and time entries.  This is a full-featured Ruby client to the Mavenlink REST API.
+
+{Mavenlink's}[http://mavenlink.com] project collaboration suite allows you to manage your business relationships, share files, and track project activity online from anywhere in the world. Within a project workspace in Mavenlink, you can agree on budget & schedule, track time, send invoices, get paid via PayPal, and complete work.
+
+== The REST API
+
+We have full {REST API and Ruby client documentation on the wiki}[https://github.com/mavenlink/mavenlink_ruby_api/wiki].
+
+== Example Usage
+
+  (sudo) gem install mavenlink
+  > require 'rubygems'
+  > require 'mavenlink'
+  > client = Mavenlink::Client.new(<user_id>, '<api_token>')
+  > workspaces = client.workspaces(:per_page => 10)
+  > workspaces.first.title
+  "This is my workspace!"
+  > workspaces.first.time_entries.length
+  20
+  > workspaces.first.expenses.length
+  4
+  > workspaces.first.stories.length
+  4
+  > posts = workspaces.first.posts
+  > posts.length
+  5
+  > posts.first.message
+  "This is an example message."
+  > post = workspaces.first.create_post(:message => "Hello!")
+  > post.message
+  "Hello!"
+  > post.update(:message => "I edited my post")
+  true
+  > post.message
+  "I edited my post"
+  > post.update(:message => "")
+  false
+  > post.errors
+  ["A message is required"]
+  > post.destroy
+  true
+
+== Credentials
+
+=== Finding your User ID and API Token
+
+Your User ID and API Token are both available on your Mavenlink account page at the bottom of the first tab.
+
+=== Security
+
+For security, the API is provided over SSL only.  Additionally, you should consider your API Token to be much like a password.  Someone with your token can make changes to your Mavenlink account and perform actions in your name.  If you believe that your token has been compromised, login to Mavenlink and reset your token from your account page.
+
+== Contributing to the Mavenlink Ruby API Client
+
+We strive to keep the Ruby API up-to-date with our REST API.  However, if you find a feature missing, feel free to contribute it. 
+
+* 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
+* Write a failing rspec test case, write code until your test passes, rinse, repeat.
+* Commit and push until you are happy with your contribution
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or it is otherwise necessary, that is fine, but please isolate it to its own commit so that we can cherry-pick around it as needed.
+
+== Copyright
+
+Copyright (c) 2011 Mavenlink, LLC. See LICENSE.txt for further details.

data/Rakefile

@@ -1,28 +1,54 @@
-#!/usr/bin/env rake
+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 = "mavenlink"
+  gem.homepage = "http://github.com/mavenlink/mavenlink_ruby_api"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby client for Mavenlink's API}
+  gem.description = %Q{This is a Ruby API client for Mavenlink.  Mavenlink's project collaboration suite allows you to manage your business relationships, share files, and track project activity online from anywhere in the world. Within a project workspace in Mavenlink, you can agree on budget & schedule, track time, send invoices, get paid via PayPal, and complete work.}
+  gem.email = "support@mavenlink.com"
+  gem.authors = ["Roger Neel", "Andrew Cantino"]
+
+  gem.add_runtime_dependency "httparty", "0.7.4"
+
+  gem.add_development_dependency "webmock", "~> 1.6.2"
+  gem.add_development_dependency "rspec", "~> 2.3.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.2"
+  gem.add_development_dependency "rr", "~> 1.0.2"
+  gem.add_development_dependency "json", "~> 1.5.1"
+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') : ""
 
-RSpec::Core::RakeTask.new :spec
-task default: :spec
-
-desc 'Runs irb console and initializes the API'
-task :console, :token do |_, args|
-  require 'irb'
-  require 'mavenlink'
-  require 'awesome_print'
-
-  token = ENV['TOKEN'] || args[:token]
-  Mavenlink.oauth_token = token
-
-  Mavenlink.logger = Mavenlink::Logger.new(STDOUT)
-  Mavenlink.logger.level = Logger::DEBUG # Change to Logger::INFO not to display responses
-  if token
-    Mavenlink.logger.hint "Using #{token} token."
-  else
-    Mavenlink.logger.disappointment 'No token set! Please put TOKEN=xxxx into your .env file or set manually.'
-  end
-
-  AwesomePrint.irb!
-  ARGV.clear
-  IRB.start
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mavenlink #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/TODO

@@ -0,0 +1,18 @@
+## CLIENT TODO
+- Document expenses on the wiki (/expenses and /workspaces/2/expenses).
+- Document reload available on all models.
+- Document error responses, such as:
+    => expense
+    => #<Mavenlink::Expense:0x101aeb760 @json={"category"=>"Some Category", "created_at"=>"2011...
+    expense.destroy
+    => false
+    expense.errors
+    => ["Expense 23456 cannot be deleted because it is in an active invoice"]
+    expense.update :foo => :bar
+    => false
+    expense.errors
+    => ["Unknown params: expense[foo]. Known params: expense[date] is the expense date in the form MM/DD/YYYY, expense[amount_in_cents] is the amount of this expense in the base units of the workspace currency (i.e., cents for USD), expense[notes] are the notes, if any, associated with this expense, expense[category] is the expense category"]
+
+## API TODO
+- Add user endpoint
+- Add invoices endpoint

data/VERSION

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

data/lib/mavenlink.rb

@@ -1,134 +1,2 @@
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/hash/slice'
-require 'active_support/core_ext/object/try'
-require 'active_support/core_ext/string/inflections'
-require 'active_model'
-require 'yaml'
-require 'json'
-require 'brainstem-adaptor'
-require 'faraday'
-
-module Mavenlink
-  VERSION = '0.0.1'
-
-  # Returns HTTP framework
-  def self.adapter
-    @adapter || Faraday.default_adapter
-  end
-
-  # @param value Any valid Faraday adapter
-  def self.adapter=(value)
-    @adapter = value
-  end
-
-  def self.client
-    @client ||= Mavenlink::Client.new
-  end
-
-  # @return [Mavenlink::Settings]
-  def self.default_settings
-    Mavenlink::Settings[:default]
-  end
-
-  def self.logger
-    @logger ||= Mavenlink::Logger.new(nil)
-  end
-
-  def self.logger=(value)
-    @logger = value
-  end
-
-  # @param token [String]
-  def self.oauth_token=(token)
-    default_settings[:oauth_token] = token
-  end
-
-  # Forces models to perform validations if true
-  # If false performs requests without running validations described in specification file
-  # Default behavior is not to validate anything
-  # @param enabled [true, false]
-  def self.perform_validations=(enabled)
-    default_settings[:perform_validations] = enabled
-  end
-
-  # @param [String] version
-  # @return [Api]
-  def self.specification
-    @specification ||= BrainstemAdaptor::Specification.new(YAML.load_file(File.join(File.dirname(__FILE__), 'config', 'specification.yml')))
-  end
-
-  def self.stub_requests(&block)
-    stubbed_requests = Faraday::Adapter::Test::Stubs.new(&block)
-    self.adapter = [:test, stubbed_requests]
-  end
-end
-
-require 'mavenlink/settings'
-require 'mavenlink/errors'
-require 'mavenlink/request'
-require 'mavenlink/response'
-require 'mavenlink/client'
-require 'mavenlink/logger'
-require 'mavenlink/concerns/custom_fieldable'
-require 'mavenlink/concerns/indestructible'
-require 'mavenlink/concerns/locked_record'
-require 'mavenlink/specificators/base'
-require 'mavenlink/specificators/attribute'
-require 'mavenlink/specificators/association'
-require 'mavenlink/specificators/validation'
-require 'mavenlink/model'
-require 'mavenlink/account_invitation'
-require 'mavenlink/account_membership'
-require 'mavenlink/additional_item'
-require 'mavenlink/assignment'
-require 'mavenlink/attachment'
-require 'mavenlink/backup_approver_association'
-require 'mavenlink/cost_rate'
-require 'mavenlink/custom_field'
-require 'mavenlink/custom_field_value'
-require 'mavenlink/custom_field_choice'
-require 'mavenlink/expense'
-require 'mavenlink/expense_category'
-require 'mavenlink/expense_report_submission'
-require 'mavenlink/external_payment'
-require 'mavenlink/fixed_fee_item'
-require 'mavenlink/external_reference'
-require 'mavenlink/holiday'
-require 'mavenlink/holiday_calendar'
-require 'mavenlink/holiday_calendar_association'
-require 'mavenlink/holiday_calendar_membership'
-require 'mavenlink/invoice'
-require 'mavenlink/organization'
-require 'mavenlink/organization_membership'
-require 'mavenlink/participation'
-require 'mavenlink/post'
-require 'mavenlink/project_template'
-require 'mavenlink/project_template_assignment'
-require 'mavenlink/skill'
-require 'mavenlink/skill_category'
-require 'mavenlink/skill_membership'
-require 'mavenlink/status_report'
-require 'mavenlink/story'
-require 'mavenlink/story_allocation_day'
-require 'mavenlink/story_dependency'
-require 'mavenlink/story_task'
-require 'mavenlink/tag'
-require 'mavenlink/time_adjustment'
-require 'mavenlink/time_entry'
-require 'mavenlink/time_off_entry'
-require 'mavenlink/timesheet_submission'
-require 'mavenlink/rate_card'
-require 'mavenlink/rate_card_role'
-require 'mavenlink/rate_card_set'
-require 'mavenlink/rate_card_set_version'
-require 'mavenlink/rate_card_version'
-require 'mavenlink/resolution'
-require 'mavenlink/role' # NOTE(SZ): remove
-require 'mavenlink/user'
-require 'mavenlink/vendor'
-require 'mavenlink/workspace'
-require 'mavenlink/workspace_invoice_preference'
-require 'mavenlink/workspace_group'
-require 'mavenlink/workweek'
-require 'mavenlink/workweek_membership'
-require 'mavenlink/railtie' if defined?(Rails)
+require File.expand_path(File.join(File.dirname(__FILE__), 'mavenlink', 'base'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'mavenlink', 'client'))

data/lib/mavenlink/base.rb

@@ -0,0 +1,184 @@
+require 'httparty'
+
+module Mavenlink
+  class Base
+    include HTTParty
+    headers 'Accept' => 'application/json'
+    format :json
+
+    attr_accessor :json, :path_params, :basic_auth, :errors
+
+    def initialize(json, options = {})
+      self.path_params = options[:path_params] || {}
+      self.basic_auth = options[:basic_auth]
+      set_json json
+    end
+
+    def id
+      json['id']
+    end
+    
+    def request_path
+      p = self.class.request_path.to_s
+      params = path_params.dup
+      params[:id] = id if id
+      params.each do |key, value|
+        p = p.gsub(key.inspect, value.to_s)
+      end
+      p
+    end
+    
+    def join_paths(original, append)
+      original = original + "/" unless original =~ /\/$/
+      original = "/" + original unless original =~ /^\//
+      append = append.gsub(/^\//, '')
+      uri = URI.parse("http://www.example.com#{original}")
+      (uri + append).path.gsub(/\/$/, '')
+    end
+    
+    def get_request(path, options = {})
+      puts "GET #{path}" if self.class.debug
+      self.class.get path, :query => options, :basic_auth => basic_auth
+    end
+
+    def put_request(path, options = {})
+      puts "PUT #{path}" if self.class.debug
+      self.class.put path, :body => options, :basic_auth => basic_auth
+    end
+
+    def post_request(path, options = {})
+      puts "POST #{path}" if self.class.debug
+      self.class.post path, :body => options, :basic_auth => basic_auth
+    end
+
+    def delete_request(path, options = {})
+      puts "DELETE #{path}" if self.class.debug
+      self.class.delete path, :query => options, :basic_auth => basic_auth
+    end
+
+    def update(changes)
+      response = put_request(request_path, self.class.class_name => changes)
+      if response.code == 200
+        set_json response.parsed_response
+        true
+      elsif response.code == 422
+        self.errors = response.parsed_response['errors']
+        false
+      else
+        raise "Server error code #{response.code}"
+      end
+    end
+
+    def destroy
+      response = delete_request(request_path)
+      if response.code == 200
+        true
+      elsif response.code == 422
+        self.errors = response.parsed_response['errors']
+        false
+      else
+        raise "Server error code #{response.code}"
+      end
+    end
+
+    def reload(options = {})
+      result = get_request(request_path, options)
+      if result.code == 200
+        set_json result.parsed_response
+      else
+        raise "Server error code #{result.code}"
+      end
+      self
+    end
+    
+    protected
+
+    def set_json(j)
+      self.errors = []
+      self.json = j
+      wrap_contained_objects
+    end
+
+    def wrap_contained_objects
+      (self.class.contains || {}).keys.each do |method|
+        json[method.to_s] = if !json.has_key?(method.to_s)
+                              nil
+                            elsif json[method.to_s].is_a?(Array)
+                              json[method.to_s].map do |data|
+                                options = get_contains_options(method.to_sym, data)
+                                options[:class].new(data, :basic_auth => basic_auth, :path_params => options[:path_params] || {})
+                              end
+                            else
+                              options = get_contains_options(method.to_sym, json[method.to_s])
+                              options[:class].new(json[method.to_s], :basic_auth => basic_auth, :path_params => options[:path_params] || {})
+                            end
+      end
+    end
+
+    def build(path, klass, options, new_path_params = {})
+      response = post_request(join_paths(request_path, path), klass.class_name => options)
+      if response.code == 200
+        klass.new(response.parsed_response, :basic_auth => basic_auth, :path_params => handle_proc(new_path_params, response.parsed_response))
+      elsif response.code == 422
+        k = klass.new(response.parsed_response, :basic_auth => basic_auth, :path_params => handle_proc(new_path_params, response.parsed_response))
+        k.errors = response.parsed_response['errors']
+        k
+      else
+        raise "Server error code #{response.code}"
+      end
+    end
+
+    def fetch(path, klass, options, new_path_params = {})
+      result = get_request(join_paths(request_path, path), options)
+      if result.code == 200
+        if result.parsed_response.is_a?(Array)
+          result.parsed_response.map { |data| klass.new(data, :basic_auth => basic_auth, :path_params => handle_proc(new_path_params, data)) }
+        else
+          klass.new(result.parsed_response, :basic_auth => basic_auth, :path_params => handle_proc(new_path_params, result.parsed_response))
+        end
+      else
+        raise "Server error code #{result.code}"
+      end
+    end
+    
+    def handle_proc(possibly_proc, *args)
+      (possibly_proc && possibly_proc.is_a?(Proc) && possibly_proc.call(*args)) || possibly_proc
+    end
+
+    def get_contains_options(method, data)
+      if self.class.contains[method].is_a?(Class)
+        { :class => self.class.contains[method] }
+      elsif self.class.contains[method].is_a?(Proc)
+        self.class.contains[method].call(self, data)
+      elsif self.class.contains[method].is_a?(Hash)
+        self.class.contains[method]
+      else
+        nil
+      end
+    end
+
+    def method_missing(method)
+      json.has_key?(method.to_s) ? json[method.to_s] : super
+    end
+
+    def self.contains(c = nil)
+      @contains = c if c
+      @contains
+    end
+
+    def self.request_path(p = nil)
+      @request_path = p if p
+      @request_path
+    end
+
+    def self.class_name(c = nil)
+      @class_name = c if c
+      @class_name
+    end
+
+    def self.debug(state = :not_set)
+      @@debug = state unless state == :not_set
+      @@debug
+    end
+  end
+end