mite-rb 0.1.0 → 0.2.0

data/CHANGES.txt

@@ -1,5 +1,20 @@
 = mite-rb Changelog
 
+== Version 0.2.0 (not completed)
+
+* Added singleton resources account and myself (current authenticated user)
+* Removed depreciated undo method
+* Do not require rubygems
+* Added Method to validate the connection to mite
+
+== Version 0.1.0
+
+* Use absolute classes to prevent collision with other classes
+
+== Version 0.0.3
+
+* Fixed wrong domain_name (old one for testung removed)
+
 == Version 0.0.2
 
 * Added tracker-resource and methods on time_entry

data/README.textile

@@ -2,14 +2,18 @@ The official ruby library for interacting with the "RESTful API":http://mite.yo.
 
 h3. Install
 
-As a ruby gem from github:
+As a ruby gem from gemcutter:
    
-   sudo gem install yolk-mite-rb -s http://gems.github.com
+   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'
@@ -24,7 +28,19 @@ or, use your api key:
 
    Mite.key = 'cdfeasdaabcdefgssaeabcdefg'
 
-You should read the complete mite.api documentation at http://mite.yo.lk/en/api
+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
 
@@ -61,10 +77,5 @@ 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/VERSION.yml

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

data/lib/mite/account.rb

@@ -0,0 +1,3 @@
+class Mite::Account < Mite::SingletonBase
+  
+end

data/lib/mite/myself.rb

@@ -0,0 +1,3 @@
+class Mite::Myself < Mite::SingletonBase
+  
+end

data/lib/mite/user.rb

@@ -1,19 +1,8 @@
 class Mite::User < Mite::Base
   
+  include Mite::NoWriteAccess
+  
   def time_entries(options = {})
     Mite::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

@@ -1,6 +1,3 @@
-$:.unshift(File.dirname(__FILE__))
-
-require 'rubygems'
 require 'activesupport'
 require 'activeresource'
 
@@ -43,23 +40,53 @@ module Mite
     def resources
       @resources ||= []
     end
+  
+    # Validates connection
+    # returns true when valid false when not
+    def validate
+      validate! rescue false
+    end
+    
+    # Same as validate_connection 
+    # but raises http-error when connection is invalid
+    def validate!
+      !!Mite::Account.find
+    end
   end
   
   self.host_format   = '%s://%s%s'
   self.domain_format = '%s.mite.yo.lk'
   self.protocol      = 'http'
   self.port          = ''
+  
+  class MethodNotAvaible < StandardError; end
+  
+  module NoWriteAccess
+    def save
+      raise MethodNotAvaible, "Cannot save #{self.class.name} over mite.api"
+    end
+
+    def create
+      raise MethodNotAvaible, "Cannot save #{self.class.name} over mite.api"
+    end
 
+    def destroy
+      raise MethodNotAvaible, "Cannot save #{self.class.name} over mite.api"
+    end
+  end
+  
   class Base < ActiveResource::Base
     class << self
       
       def inherited(base)
-        Mite.resources << base
-        class << base
-          attr_accessor :site_format
+        unless base == Mite::SingletonBase
+          Mite.resources << base
+          class << base
+            attr_accessor :site_format
+          end
+          base.site_format = '%s'
+          base.timeout = 20
         end
-        base.site_format = '%s'
-        base.timeout = 20
         super
       end
       
@@ -75,31 +102,51 @@ module Mite
       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
+  end
+  
+  class SingletonBase < Base
+    include NoWriteAccess
     
-    # 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)
+    class << self
+      def collection_name
+        element_name
+      end
+
+      def element_path(id, prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+      end
+
+      def collection_path(prefix_options = {}, query_options = nil) 
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil? 
+        "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}" 
       end
     end
-  
+    
+    def find
+      super(1)
+    end
+    
+    alias_method :first, :find
+    alias_method :last, :find
+
+    # Prevent collection methods
+    def all
+      raise MethodNotAvaible, "Method not supported on #{self.class.name}"
+    end
   end
   
-  class Error < StandardError; end
 end
 
+$:.unshift(File.dirname(__FILE__))
+
 require 'mite/customer'
 require 'mite/project'
 require 'mite/service'
 require 'mite/time_entry'
 require 'mite/time_entry_group'
 require 'mite/tracker'
-require 'mite/user'
+require 'mite/user'
+require 'mite/myself'
+require 'mite/account'

data/mite-rb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mite-rb}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sebastian Munz"]
-  s.date = %q{2009-10-15}
+  s.date = %q{2009-11-05}
   s.description = %q{The official ruby library for interacting with the RESTful mite.api.}
   s.email = %q{sebastian@yo.lk}
   s.extra_rdoc_files = [
@@ -24,7 +24,9 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION.yml",
      "lib/mite-rb.rb",
+     "lib/mite/account.rb",
      "lib/mite/customer.rb",
+     "lib/mite/myself.rb",
      "lib/mite/project.rb",
      "lib/mite/service.rb",
      "lib/mite/time_entry.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mite-rb
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sebastian Munz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 +02:00
+date: 2009-11-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,7 +49,9 @@ files:
 - Rakefile
 - VERSION.yml
 - lib/mite-rb.rb
+- lib/mite/account.rb
 - lib/mite/customer.rb
+- lib/mite/myself.rb
 - lib/mite/project.rb
 - lib/mite/service.rb
 - lib/mite/time_entry.rb