mite-rb 0.2.0 → 0.2.1

data/CHANGES.txt

@@ -1,6 +1,10 @@
 = mite-rb Changelog
 
-== Version 0.2.0 (not completed)
+== Version 0.2.1
+
+* Added archived and active collection-methods to Customer, Project, Service and User
+
+== Version 0.2.0
 
 * Added singleton resources account and myself (current authenticated user)
 * Removed depreciated undo method

data/README.markdown

@@ -0,0 +1,96 @@
+## mite-rb
+
+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.
+
+## Install
+
+Install the lib as a ruby gem from gemcutter:
+   
+    sudo gem install mite-rb -s http://gemcutter.org
+
+mite-rb requires activeresource and activesupport in version 2.3.2 or above.
+
+## Documentation
+
+You should read the complete *mite*.api documentation at [http://mite.yo.lk/en/api](http://mite.yo.lk/en/api)
+
+### Authenticate
+
+**IMPORTANT:** To use mite-rb you **must** enable the *mite*.api for your user within the webinterface of *mite*! It is disabled by default.
+
+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* set the account to 'demo':
+
+    Mite.account = 'demo'
+
+Then, you should set the authentication. You can either use your mite.api key (recommanded) or your login credentials (email and password).
+    
+    Mite.key = 'cdfeasdaabcdefgssaeabcdefg'
+    
+or
+    
+    Mite.authenticate('rick@techno-weenie.net', 'spacemonkey')
+
+### Validate connection
+
+You can validate the connection/authentication with
+
+    Mite.validate
+  
+This will return true when the connection is valid and false if not.
+
+Use
+
+    Mite.validate!
+  
+and mite-rb will raise an exception with further details when the connection is not valid.
+
+### Project
+
+#### Find all active projects
+
+    Mite::Project.all
+    
+#### Find all archived projects
+
+    Mite::Project.archived
+    
+#### Find projects where name contains 'web'
+
+    Mite::Project.all(:params => {:name => 'web'})
+   
+#### Find single project by ID
+
+    Mite::Project.find(1209)
+    
+#### Get all time entries of a project
+
+    project = Mite::Project.find(1209)
+    project.time_entries
+    
+#### Get the customer of a project
+
+    project = Mite::Project.find(1209)
+    project.customer
+ 
+#### Creating
+
+    project = Mite::Project.new(:name => 'Playing with the mite.api')
+    project.save
+
+or in a single step
+ 
+    project = Mite::Project.create(:name => 'Playing with the mite.api') 
+ 
+#### Updating
+
+    project = Mite::Project.find(1209)
+    project.name = "mite.api"
+    project.customer = Mite::Customer.find(384)
+    project.save
+ 
+#### Deleting
+
+    project = Mite::Project.find(1209)
+    project.destroy
+
+

data/VERSION.yml

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

data/lib/mite/customer.rb

@@ -1,4 +1,7 @@
 class Mite::Customer < Mite::Base
+  
+  include Mite::ResourceWithActiveArchived
+  
   def time_entries(options = {})
     Mite::TimeEntry.find(:all, :params => options.update(:customer_id => id))
   end

data/lib/mite/project.rb

@@ -1,5 +1,7 @@
 class Mite::Project < Mite::Base
   
+  include Mite::ResourceWithActiveArchived
+  
   def time_entries(options = {})
     Mite::TimeEntry.find(:all, :params => options.update(:project_id => id))
   end

data/lib/mite/service.rb

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

data/lib/mite/user.rb

@@ -1,6 +1,7 @@
 class Mite::User < Mite::Base
   
-  include Mite::NoWriteAccess
+  include Mite::ResourceWithoutWriteAccess
+  include Mite::ResourceWithActiveArchived
   
   def time_entries(options = {})
     Mite::TimeEntry.find(:all, :params => options.update(:user_id => id))

data/lib/mite-rb.rb

@@ -61,7 +61,7 @@ module Mite
   
   class MethodNotAvaible < StandardError; end
   
-  module NoWriteAccess
+  module ResourceWithoutWriteAccess
     def save
       raise MethodNotAvaible, "Cannot save #{self.class.name} over mite.api"
     end
@@ -75,6 +75,22 @@ module Mite
     end
   end
   
+  module ResourceWithActiveArchived
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def archived(options={})
+        find(:all, options.update(:from => :archived))
+      end
+      
+      def active(options={})
+        find(:all, options)
+      end
+    end
+  end
+  
   class Base < ActiveResource::Base
     class << self
       
@@ -92,7 +108,7 @@ module Mite
       
       # Common shortcuts known from ActiveRecord
       def all(options={})
-        find_every(options)
+        find(:all, options)
       end
 
       def first(options={})
@@ -106,7 +122,7 @@ module Mite
   end
   
   class SingletonBase < Base
-    include NoWriteAccess
+    include ResourceWithoutWriteAccess
     
     class << self
       def collection_name

data/mite-rb.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mite-rb}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sebastian Munz"]
-  s.date = %q{2009-11-05}
+  s.date = %q{2009-11-06}
   s.description = %q{The official ruby library for interacting with the RESTful mite.api.}
   s.email = %q{sebastian@yo.lk}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.textile"
+     "README.markdown"
   ]
   s.files = [
     ".gitignore",
      "CHANGES.txt",
      "LICENSE",
-     "README.textile",
+     "README.markdown",
      "Rakefile",
      "VERSION.yml",
      "lib/mite-rb.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mite-rb
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Sebastian Munz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-05 00:00:00 +01:00
+date: 2009-11-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,12 +40,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.textile
+- README.markdown
 files: 
 - .gitignore
 - CHANGES.txt
 - LICENSE
-- README.textile
+- README.markdown
 - Rakefile
 - VERSION.yml
 - lib/mite-rb.rb

data/README.textile

@@ -1,81 +0,0 @@
-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 gemcutter:
-   
-   sudo gem install mite-rb -s http://gemcutter.org
-
-mite-rb requires activeresource and activesupport gems in a current version (2.3.2) to be installed.
-
-h3. Documentation
-
-You should read the complete mite.api documentation at http://mite.yo.lk/en/api
-
-h4. Authenticate
-
-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'
-
-h4. Validate connection
-
-You can validate the connection/authentication with
-
-  Mite.validate
-  
-This will return true when the connection is valid and false if not.
-
-Use
-
-  Mite.validate!
-  
-and mite-rb will raise an exception with further details when the connection is not valid.
-
-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
-
-