storage_room 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,7 @@
+=== Version 0.1.1
+
+* Added rdoc
+
 === Version 0.1.0 
 
 * Initial Version

data/README.rdoc

@@ -28,6 +28,8 @@ This is a walkthrough with all steps you need to setup a devise resource, includ
     puts "Could not save Resource: #{resource.errors.join(', )}"
   end
 
+You can find the documentation at http://rdoc.info/github/thriventures/storage_room_gem.
+
 == More Examples
 
 See the examples folder.

data/TODO

@@ -1,6 +1,4 @@
 - rdoc
-- gemcutter
-
 
 
 == Version X

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/storage_room.rb

@@ -33,7 +33,8 @@ module StorageRoom
     attr_reader :ssl
     attr_reader :proxy_server
     attr_reader :proxy_port
-  
+    
+    # Authenticate once before making any requests with your account id and the application's api key
     def authenticate(account_id, api_key)
       Base.basic_auth(api_key, 'X')
       @api_key = api_key
@@ -41,37 +42,36 @@ module StorageRoom
       update_uri
     end
     
+    # Change the user agent that is sent with all requests
     def user_agent=(agent)
       Base.headers.merge!('User-Agent' => agent)
       @user_agent = agent
     end
-
-    def server=(server)
+    
+    # Change the server to connect to. This should only be relevant for developers of the library.
+    def server=(server) #:nodoc:
       @server = server
       update_uri
     end
     
-    def server
+    def server #:nodoc:
       @server || 'api.storageroomapp.com'
     end
-        
+    
+    # Requests are made with SSL
     def ssl=(ssl)
       @ssl = ssl
       update_uri
     end
     
+    # Set an HTTP proxy server
     def http_proxy(server, port)
       @proxy_server = server
       @proxy_port = port
       Base.http_proxy(server, port)
     end
     
-    def update_uri
-      protocol = self.ssl == true ? 'https' : 'http'
-      
-      Base.base_uri "#{protocol}://#{self.server}/accounts/#{self.account_id}"
-    end
-    
+    # Return a Ruby class for a StorageRoom type
     def class_for_name(name)        
       if StorageRoom.const_defined?(name)  
         "StorageRoom::#{name}".constantize
@@ -85,5 +85,13 @@ module StorageRoom
       end
     end
     
+    private
+    
+      def update_uri
+        protocol = self.ssl == true ? 'https' : 'http'
+      
+        Base.base_uri "#{protocol}://#{self.server}/accounts/#{self.account_id}"
+      end
+    
   end
 end

data/lib/storage_room/array.rb

@@ -1,17 +1,15 @@
 module StorageRoom
+  # A container object that contains many models (collections or resources)
   class Array < Base
     attr_accessor :items
     
-    class << self      
-
-    end
-    
-    
+        
     def initialize(attributes = {})
       self.items = []
       super
     end
     
+    # Set the array with the attributes from the API
     def set_from_api(attributes)
       super(attributes)
                   
@@ -19,11 +17,13 @@ module StorageRoom
       attributes.delete('items')  
     end
     
+    # Reset the Array to its default state with all attributes unset
     def reset!
       super
       @items = []
     end
     
+    # Replaces the objects content with the next page of the array if a next page exists
     def load_next_page!
       if self[:@next_page].present?
         reload(self[:@next_page]) 

data/lib/storage_room/attributes.rb

@@ -1,33 +1,42 @@
 module StorageRoom
+  
+  # Module that contains attributes methods shared between StorageRoom::Base and StorageRoom::Embedded
   module Attributes
+    # Optionally pass attributes to set up the object
     def initialize(attributes={})     
       self.attributes = attributes
     end
     
+    # Set the attributes of an object with a hash from the API
     def set_from_api(attributes)
       reset!
       
       self.attributes = attributes
     end
         
+    # Shortcut to get an attribute. 
     def [](name)
       self.attributes[name]
     end
     
+    # Shortcut to set an attribute
     def []=(name, value)
       self.attributes[name] = value
     end
     
+    # Return all of the objects attributes
     def attributes
       @attributes ||= Hash.new.with_indifferent_access
     end
     
+    # Set the objects attributes with a hash. Only attributes passed in the hash are changed, existing ones are not overridden.
     def attributes=(hash = {})
       hash.each do |k, v|
         self.attributes[k] = v
       end
     end
     
+    # Reset an object to its initial state with all attributes unset
     def reset!
       @attributes = Hash.new.with_indifferent_access
     end

data/lib/storage_room/base.rb

@@ -1,4 +1,5 @@
 module StorageRoom
+  # The superclass of all the classes that load data from the API
   class Base
     include Attributes
     include HTTParty
@@ -8,6 +9,7 @@ module StorageRoom
 
     
     class << self
+      # Load an object with the specified URL from the API
       def load(url, parameters = {})
         httparty = get(url, parameters)
         
@@ -15,7 +17,8 @@ module StorageRoom
         create_from_api(httparty.parsed_response.first[1])
       end
       
-      def handle_critical_response_errors(httparty)
+      # Handle known server errors
+      def handle_critical_response_errors(httparty) # :nodoc:
         case httparty.response.code
           when '200', '201', '422' then true
           else
@@ -23,7 +26,8 @@ module StorageRoom
         end
       end
       
-      def create_from_api(hash) 
+      # Creates a new object with a hash from the API with a @type attribute
+      def create_from_api(hash)  # :nodoc:
         type = hash['@type']
         
         object = case type
@@ -36,18 +40,21 @@ module StorageRoom
         object.set_from_api(hash)
         object
       end
-            
-      def meta_data?(key)
+      
+      # Find out if a key is user-defined or meta-data (begins with @)      
+      def meta_data?(key) 
         key[0...1] == '@'
       end            
     end
     
+    # Reload an object from the API. Optionally pass an URL.
     def reload(url = nil, parameters = {})
       httparty = self.class.get(url || self[:@url], parameters)
       set_from_api(httparty.parsed_response.first[1])
       true
     end
-            
+       
+    # Returns the remote URL of the object        
     def url
       self[:@url]
     end

data/lib/storage_room/embedded.rb

@@ -1,4 +1,5 @@
 module StorageRoom
+  # An embedded object that is not only a simple type (like an integer, string)
   class Embedded
     include Attributes
     

data/lib/storage_room/embeddeds/file.rb

@@ -1,4 +1,5 @@
 module StorageRoom
+  # A file that is embedded in a resource
   class File < Embedded
     
   end

data/lib/storage_room/embeddeds/location.rb

@@ -1,4 +1,5 @@
 module StorageRoom
+  # A location with coordinates that is embedded in a resource
   class Location < Embedded
     
   end

data/lib/storage_room/field.rb

@@ -1,4 +1,5 @@
 module StorageRoom
+  # A field that is part of a collection
   class Field
 
     

data/lib/storage_room/model.rb

@@ -1,33 +1,39 @@
 module StorageRoom
+  # Abstract superclass for classes that can persist to the remote servers
   class Model < Base
     class << self
+      # Create a new model with the passed attributes
       def create(attributes={})
         resource = new(attributes)
         resource.create
         resource
       end
       
+      # Get all models (could be paginated)
       def all
         load(index_path)
       end
       
+      # Find a model with the specified id
       def find(id)
         load(show_path(id))
       end
-            
-      def index_path
+      
+      #       
+      def index_path # :nodoc:
         raise StorageRoom::AbstractMethod.new
       end
       
-      def show_path(id)
+      def show_path(id) # :nodoc:
         raise StorageRoom::AbstractMethod.new
       end
       
-      def json_name
+      def json_name  # :nodoc:
         raise StorageRoom::AbstractMethod.new
       end
     end
     
+    # Create a new model and set its attributes
     def initialize(attributes={})     
       @new_record = true
       @errors = []
@@ -35,6 +41,7 @@ module StorageRoom
       super
     end
     
+    # Set the attributes of the model from the API
     def set_from_api(attributes)
       super
       @new_record = false
@@ -42,6 +49,7 @@ module StorageRoom
       self.attributes
     end
     
+    # Reset the model to its default state
     def reset!
       super
       @new_record = true
@@ -49,26 +57,31 @@ module StorageRoom
       true
     end
     
+    # Has this model been saved to the API already?
     def new_record?
       @new_record ? true : false
     end
     
+    # Create a new model or update an existing model on the server
     def save
       new_record? ? create : update
     end
     
+    # Create a new model on the server
     def create
       return false unless new_record?
       httparty = self.class.post(self.class.index_path, :body => to_json)
       handle_save_response(httparty)
     end
     
+    # Update an existing model on the server
     def update
       return false if new_record?
       httparty = self.class.put(url, :body => to_json)
       handle_save_response(httparty)
     end
     
+    # Delete an existing model on the server
     def destroy
       return false if new_record?
       
@@ -78,14 +91,16 @@ module StorageRoom
       true
     end
     
+    # Is the model valid or were there validation errors on the server?
     def valid?
       self.errors.empty?
     end
     
-    def as_json(args = {})
+    def as_json(args = {}) # :nodoc:
       {self.class.json_name => self.attributes.reject{|k, v| self.class.meta_data?(k)}}
     end
     
+    # The validation errors that were returned by the server
     def errors
       @errors ||= []
     end
@@ -95,7 +110,7 @@ module StorageRoom
     # ===================
     
     private
-      def handle_save_response(httparty)
+      def handle_save_response(httparty) # :nodoc:
         self.class.handle_critical_response_errors(httparty)
         
         if httparty.response.code == '200' || httparty.response.code == '201'

data/lib/storage_room/models/collection.rb

@@ -1,27 +1,30 @@
 module StorageRoom
+  # A collection is used to define the structure of a data set. 
   class Collection < Model        
     class << self                  
-      def index_path
+      def index_path # :nodoc:
         '/collections'
       end
       
-      def show_path(collection_id)
+      def show_path(collection_id) # :nodoc:
         "#{index_path}/#{collection_id}"
       end
       
-      def resources_path(collection_id)
+      def resources_path(collection_id) # :nodoc:
         "#{show_path(collection_id)}/resources"
       end
       
-      def json_name
+      def json_name # :nodoc:
         'collection'
       end
     end
     
+    # Load all the resources of a collection
     def resources
       Array.load(self[:@resources_url])
     end
     
+    # The class of the collection's objects
     def resource_class
       StorageRoom.class_for_name(self[:identifier].classify)
     end

data/lib/storage_room/models/resource.rb

@@ -1,35 +1,37 @@
 module StorageRoom
   class Resource < Model
     class << self                  
-      def index_path
+      def index_path # :nodoc:
         "/collections/#{collection_id}/resources" 
       end
       
-      def show_path(resource_id)
+      def show_path(resource_id) # :nodoc:
         "#{index_path}/#{resource_id}"
       end
       
-      def collection_path
+      def collection_path # :nodoc:
         "/collections/#{collection_id}"
       end
       
-      def collection_id
+      def collection_id # :nodoc:
         self.name.gsub('StorageRoom::', '').tableize
       end
       
-      def json_name
+      def json_name # :nodoc:
         'resource'
       end
       
-      def search_path(parameters = {})
+      def search_path(parameters = {}) # :nodoc:
         parameters.present? ? "#{index_path}?#{parameters.to_query}" : index_path
       end
       
+      # Search for objects with specific parameters
       def search(parameters = {})
         Array.load(search_path(parameters))
       end
     end
     
+    # Sets a resource with a hash from the API.
     def set_from_api(attributes)
       super(attributes)
                   
@@ -44,6 +46,7 @@ module StorageRoom
       self.attributes
     end
     
+    # The collection of a resource
     def collection
       Collection.load(self[:@collection_url] || self.class.collection_path)
     end

data/storage_room.gemspec

@@ -0,0 +1,113 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{storage_room}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sascha Konietzke"]
+  s.date = %q{2010-11-08}
+  s.description = %q{StorageRoom is a CMS system for Mobile Applications (iPhone, Android, BlackBerry, ...). This library gives you an ActiveModel-like interface to your data.}
+  s.email = %q{sascha@thriventures.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "examples/authentication.rb",
+     "examples/create_resource.rb",
+     "examples/destroy_resource.rb",
+     "examples/get_collections.rb",
+     "examples/guidebooks.csv",
+     "examples/import_csv.rb",
+     "examples/search_resources.rb",
+     "examples/update_resource.rb",
+     "lib/storage_room.rb",
+     "lib/storage_room/array.rb",
+     "lib/storage_room/attributes.rb",
+     "lib/storage_room/base.rb",
+     "lib/storage_room/embedded.rb",
+     "lib/storage_room/embeddeds/file.rb",
+     "lib/storage_room/embeddeds/location.rb",
+     "lib/storage_room/field.rb",
+     "lib/storage_room/model.rb",
+     "lib/storage_room/models/collection.rb",
+     "lib/storage_room/models/resource.rb",
+     "spec/fixtures/collection.json",
+     "spec/fixtures/collections.json",
+     "spec/fixtures/validation_error.json",
+     "spec/spec_helper.rb",
+     "spec/storage_room/array_spec.rb",
+     "spec/storage_room/attributes_spec.rb",
+     "spec/storage_room/base_spec.rb",
+     "spec/storage_room/embedded_spec.rb",
+     "spec/storage_room/embeddeds/file_spec.rb",
+     "spec/storage_room/embeddeds/location_spec.rb",
+     "spec/storage_room/field_spec.rb",
+     "spec/storage_room/model_spec.rb",
+     "spec/storage_room/models/collection_spec.rb",
+     "spec/storage_room/models/resource_spec.rb",
+     "spec/storage_room_spec.rb",
+     "storage_room.gemspec"
+  ]
+  s.homepage = %q{http://github.com/thriventures/storage_room_gem}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{StorageRoom API Wrapper (ActiveModel style)}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/storage_room/array_spec.rb",
+     "spec/storage_room/attributes_spec.rb",
+     "spec/storage_room/base_spec.rb",
+     "spec/storage_room/embedded_spec.rb",
+     "spec/storage_room/embeddeds/file_spec.rb",
+     "spec/storage_room/embeddeds/location_spec.rb",
+     "spec/storage_room/field_spec.rb",
+     "spec/storage_room/model_spec.rb",
+     "spec/storage_room/models/collection_spec.rb",
+     "spec/storage_room/models/resource_spec.rb",
+     "spec/storage_room_spec.rb",
+     "examples/authentication.rb",
+     "examples/create_resource.rb",
+     "examples/destroy_resource.rb",
+     "examples/get_collections.rb",
+     "examples/import_csv.rb",
+     "examples/search_resources.rb",
+     "examples/update_resource.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: storage_room
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sascha Konietzke
@@ -132,6 +132,7 @@ files:
 - spec/storage_room/models/collection_spec.rb
 - spec/storage_room/models/resource_spec.rb
 - spec/storage_room_spec.rb
+- storage_room.gemspec
 has_rdoc: true
 homepage: http://github.com/thriventures/storage_room_gem
 licenses: []