yolk-mite-rb 0.0.2

data/CHANGES.txt

@@ -0,0 +1,11 @@
+= mite-rb Changelog
+
+== Version 0.0.2
+
+* Added tracker-resource and methods on time_entry
+* Fixed tiny datetimebug
+* Dependency of activeresource 2.3.2 and activesupport 2.3.2
+ 
+== Version 0.0.1
+
+* Initial Version

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Yolk Sebastian Munz & Julia Soergel GbR
+
+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.textile

@@ -0,0 +1,70 @@
+The official ruby library for interacting with the "RESTful API":http://mite.yo.lk/en/api of "mite":http://mite.yo.lk/en, a sleek time tracking webapp.
+
+h3. Install
+
+As a ruby gem from github:
+   
+   sudo gem install yolk-mite-rb -s http://gems.github.com
+
+mite-rb requires activeresource and activesupport gems in a current version (2.3.2) to be installed.
+
+h3. Documentation
+
+The first thing you need to set is the account name.  This is the same as the web address (subdomain) for your account. For example if you use mite from the domain demo.mite.yo.lk:
+
+   Mite.account = 'demo'
+
+Then, you should set the authentication. You can either use your login credentials (email and password) with HTTP Basic Authentication or your mite.api key. In both cases you must enable the mite.api in your user settings.
+
+With basic authentication:
+
+   Mite.authenticate('rick@techno-weenie.net', 'spacemonkey')
+
+or, use your api key:
+
+   Mite.key = 'cdfeasdaabcdefgssaeabcdefg'
+
+You should read the complete mite.api documentation at http://mite.yo.lk/en/api
+
+h4. Project
+
+Find all active projects of the current account
+
+   Mite::Project.all
+   
+Find single project by ID
+
+   Mite::Project.find(1209)
+ 
+Creating a Project
+
+   project = Mite::Project.new(:name => 'Playing with the mite.api')
+   project.save
+
+or
+ 
+   project = Mite::Project.create(:name => 'Playing with the mite.api') 
+ 
+Updating a Project
+
+   project = Mite::Project.find(1209)
+   project.name = "mite.api"
+   project.customer = Mite::Customer.find(384)
+   project.save
+ 
+Get the customer of an project
+
+   project = Mite::Project.find(1209)
+   project.customer
+ 
+Deleting a project
+
+   project = Mite::Project.find(1209)
+   project.destroy
+ 
+Restore a destroyed project
+(will only work for aprox. 12 hours after the object was destroyed)
+
+   project = Mite::Project.undo_destroy(1209)
+
+

data/Rakefile

@@ -0,0 +1,24 @@
+task :default => [:spec]
+ 
+$gem_name = "mite-rb"
+ 
+desc "Run specs"
+task :spec do
+  sh "spec spec/* --format specdoc --color"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = $gem_name
+    s.summary = "The official ruby library for interacting with the RESTful API of mite, a sleek time tracking webapp."
+    s.email = "sebastian@yo.lk"
+    s.homepage = "http://github.com/yolk/mite-rb"
+    s.description = "The official ruby library for interacting with the RESTful mite.api."
+    s.authors = ["Sebastian Munz"]
+    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+    s.add_dependency(%q<activeresource>, [">= 2.3.2"])
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 2
+:major: 0

data/lib/mite/customer.rb

@@ -0,0 +1,9 @@
+class Mite::Customer < Mite::Base
+  def time_entries(options = {})
+    TimeEntry.find(:all, :params => options.update(:customer_id => id))
+  end
+
+  def projects(options = {})
+    Project.find(:all, :params => options.update(:customer_id => id))
+  end
+end

data/lib/mite/project.rb

@@ -0,0 +1,16 @@
+class Mite::Project < Mite::Base
+  
+  def time_entries(options = {})
+    TimeEntry.find(:all, :params => options.update(:project_id => id))
+  end
+
+  def customer
+    @customer ||= Customer.find(customer_id) unless customer_id.blank?
+  end
+  
+  def customer=(customer)
+    self.customer_id = customer ? customer.id : nil
+    @customer = customer
+  end
+  
+end

data/lib/mite/service.rb

@@ -0,0 +1,7 @@
+class Mite::Service < Mite::Base
+  
+  def time_entries(options = {})
+    TimeEntry.find(:all, :params => options.update(:service_id => id))
+  end
+  
+end

data/lib/mite/time_entry.rb

@@ -0,0 +1,54 @@
+class Mite::TimeEntry < Mite::Base
+  
+  def service
+    @service ||= Service.find(service_id) unless service_id.blank?
+  end
+  
+  def service=(service)
+    self.service_id = service ? service.id : nil
+    @service = service
+  end
+  
+  def project
+    @project ||= Project.find(project_id) unless project_id.blank?
+  end
+  
+  def project=(project)
+    self.project_id = project ? project.id : nil
+    @project = project
+  end
+  
+  def customer
+    @customer ||= begin
+      p = project
+      p.customer unless p.blank?
+    end
+  end
+  
+  def tracking?
+    !!attributes["tracker"]
+  end
+  
+  def start_tracker
+    attributes["tracker"] = Mite::Tracker.start(id) || nil
+  end
+  
+  def stop_tracker
+    Mite::Tracker.stop if tracking?
+  end
+  
+  def load(attr)
+    super(attr)
+    if attributes["tracking"]
+      attributes["tracker"] = Mite::Tracker.new.load(attributes.delete("tracking").attributes)
+    end
+    self
+  end
+  
+  class << self
+    def find_every(options={})
+      return super(options) if !options[:params] || !options[:params][:group_by]
+      TimeEntryGroup.all(options)
+    end
+  end
+end

data/lib/mite/time_entry_group.rb

@@ -0,0 +1,36 @@
+class Mite::TimeEntryGroup < Mite::Base
+  self.collection_name = "time_entries"
+  
+  attr_accessor :time_entries_params
+  
+  class << self
+    def find_every(options={})
+      return TimeEntry.all(options) if !options[:params] || !options[:params][:group_by]
+      
+      returning super(options) do |records|
+        records.each do |record| 
+          if record.attributes["time_entries_params"]
+            record.time_entries_params = record.attributes.delete("time_entries_params").attributes.stringify_keys
+          end
+        end
+      end
+    end
+  end
+  
+  def time_entries(options={})
+    return [] unless time_entries_params.is_a?(Hash)
+    
+    empty_result = false
+    
+    options[:params] ||= {}
+    options[:params].stringify_keys!
+    options[:params].merge!(time_entries_params) do |key, v1, v2|
+      empty_result = (v1 != v2)
+      v2
+    end
+    
+    return [] if empty_result
+    
+    TimeEntry.all(options)
+  end
+end

data/lib/mite/tracker.rb

@@ -0,0 +1,34 @@
+class Mite::Tracker < Mite::Base
+  
+  self.collection_name = "tracker"
+  
+  def self.current
+    tracking_time_entry = connection.get(collection_path, headers)["tracking_time_entry"]
+    tracking_time_entry ? instantiate_record(tracking_time_entry) : nil
+  end
+  
+  def self.start(time_entry_or_id)
+    id = time_entry_or_id.is_a?(Mite::TimeEntry) ? time_entry_or_id.id : time_entry_or_id
+    self.new(:id => id).start
+  end
+  
+  def self.stop
+    tracker = current 
+    tracker ? tracker.stop : false
+  end
+  
+  def start
+    response = connection.put(element_path(prefix_options), encode, self.class.headers)
+    load(self.class.format.decode(response.body)["tracking_time_entry"])
+    response.is_a?(Net::HTTPSuccess) ? self : false
+  end
+  
+  def stop
+    connection.delete(element_path, self.class.headers).is_a?(Net::HTTPSuccess) ? self : false
+  end
+  
+  def time_entry
+    Mite::TimeEntry.find(id)
+  end
+  
+end

data/lib/mite/user.rb

@@ -0,0 +1,19 @@
+class Mite::User < Mite::Base
+  
+  def time_entries(options = {})
+    TimeEntry.find(:all, :params => options.update(:user_id => id))
+  end
+  
+  def save
+    raise Error, "Cannot modify users over mite.api"
+  end
+  
+  def create
+    raise Error, "Cannot create users over mite.api"
+  end
+  
+  def destroy
+    raise Error, "Cannot destroy users over mite.api"
+  end
+
+end

data/lib/mite-rb.rb

@@ -0,0 +1,105 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'activesupport'
+require 'activeresource'
+
+# The official ruby library for interacting with the RESTful API of mite,
+# a sleek time tracking webapp.
+
+module Mite
+  
+  class << self
+    attr_accessor :email, :password, :host_format, :domain_format, :protocol, :port
+    attr_reader :account, :key
+
+    # Sets the account name, and updates all resources with the new domain.
+    def account=(name)
+      resources.each do |klass|
+        klass.site = klass.site_format % (host_format % [protocol, domain_format % name, ":#{port}"])
+      end
+      @account = name
+    end
+
+    # Sets up basic authentication credentials for all resources.
+    def authenticate(user, password)
+      resources.each do |klass|
+        klass.user = user
+        klass.password = password
+      end
+      @user     = user
+      @password = password
+      true
+    end
+
+    # Sets the mite.api key for all resources.
+    def key=(value)
+      resources.each do |klass|
+        klass.headers['X-MiteApiKey'] = value
+      end
+      @key = value
+    end
+
+    def resources
+      @resources ||= []
+    end
+  end
+  
+  self.host_format   = '%s://%s%s'
+  self.domain_format = '%s.test.yo.lk'
+  self.protocol      = 'http'
+  self.port          = ''
+
+  class Base < ActiveResource::Base
+    class << self
+      
+      def inherited(base)
+        Mite.resources << base
+        class << base
+          attr_accessor :site_format
+        end
+        base.site_format = '%s'
+        base.timeout = 20
+        super
+      end
+      
+      # Common shortcuts known from ActiveRecord
+      def all(options={})
+        find_every(options)
+      end
+
+      def first(options={})
+        find_every(options).first
+      end
+
+      def last(options={})
+        find_every(options).last
+      end
+      
+      # Undo destroy action on the resource with the ID in the +id+ parameter.
+      def undo_destroy(id)
+        returning(self.new(:id => id)) { |res| res.undo_destroy }
+      end
+    end
+    
+    # Undo destroy action.
+    def undo_destroy
+      path = element_path(prefix_options).sub(/\.([\w]+)/, '/undo_delete.\1')
+      
+      returning connection.post(path, "", self.class.headers) do |response|
+        load_attributes_from_response(response)
+      end
+    end
+  
+  end
+  
+  class Error < StandardError; end
+end
+
+require 'mite/customer'
+require 'mite/project'
+require 'mite/service'
+require 'mite/time_entry'
+require 'mite/time_entry_group'
+require 'mite/tracker'
+require 'mite/user'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: yolk-mite-rb
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Sebastian Munz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: The official ruby library for interacting with the RESTful mite.api.
+email: sebastian@yo.lk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- CHANGES.txt
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION.yml
+- lib/mite-rb.rb
+- lib/mite/customer.rb
+- lib/mite/project.rb
+- lib/mite/service.rb
+- lib/mite/time_entry.rb
+- lib/mite/time_entry_group.rb
+- lib/mite/tracker.rb
+- lib/mite/user.rb
+has_rdoc: true
+homepage: http://github.com/yolk/mite-rb
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: The official ruby library for interacting with the RESTful API of mite, a sleek time tracking webapp.
+test_files: []
+