storage_room 0.1.4 → 0.2.0

data/README.rdoc

@@ -15,7 +15,7 @@ To install the library execute:
 This is a walkthrough with all steps you need to setup a devise entry, including model, migration, route files, and optional configuration.
   
   StorageRoom.authenticate(YOUR_ACCOUNT_ID, YOUR_APPLICATION_API_KEY)
-  collection = StorageRoom::Collection.find('guidebooks')
+  collection = StorageRoom::Collection.find('4ddaf68b4d085d374a000003')
   
   entries = collection.entries
   entry = entries.resources.first

data/Rakefile

@@ -23,18 +23,15 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
 end
 
+
 task :spec => :check_dependencies
 
 task :default => :spec

data/TODO

@@ -1,3 +1,4 @@
+
 == Version X
 
 - have collection fields

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/examples/authentication.rb

@@ -1,6 +1,11 @@
 require File.dirname(__FILE__) + '/../lib/storage_room'
 
-ACCOUNT_ID = '4cef9a8c425071fa6900002f' # your account id
-APPLICATION_API_KEY = 'c499kx9L6aBfvJlvSKbF' # your application's API key with read/write access
+# ACCOUNT_ID = '4cef9a8c425071fa6900002f' # your account id
+# APPLICATION_API_KEY = 'c499kx9L6aBfvJlvSKbF' # your application's API key with read/write access
 
+ACCOUNT_ID = '4d13574cba05613d25000004'
+APPLICATION_API_KEY = 'Tg_2oR2aBc83_BJa4k0Y'
+
+# StorageRoom.server = 'api.lvh.me:3000'
+StorageRoom.http_proxy('localhost', '8888')
 StorageRoom.authenticate(ACCOUNT_ID, APPLICATION_API_KEY)

data/examples/create_entry.rb

@@ -2,18 +2,8 @@
 
 require File.dirname(__FILE__) + '/authentication'
 
-# create a entry without fetching the collection
-klass = StorageRoom.class_for_name('Guidebook')
-entry1 = klass.new(:title => 'Foo', :price => 1.23)
-
-if entry1.save
-  puts "Entry saved"
-else
-  puts "Entry could not be saved: #{entry1.errors.join(', ')}"
-end
-
 # fetch the collection first
-collection = StorageRoom::Collection.find('guidebooks')
+collection = StorageRoom::Collection.find('4ddaf68b4d085d374a000003')
 
 entry2 = collection.entry_class.new(:title => 'Bar', :price => 2.23)
 

data/examples/destroy_entry.rb

@@ -2,10 +2,10 @@
 
 require File.dirname(__FILE__) + '/authentication'
 
-collection = StorageRoom::Collection.find('guidebooks')
+collection = StorageRoom::Collection.find('4ddaf68b4d085d374a000003')
 
 entry = collection.entries.resources.first
 
 entry.destroy
 
-puts "Destroyed #{entry[:name]}"
+puts "Destroyed #{entry[:title]}"

data/examples/import_csv.rb

@@ -2,13 +2,14 @@
 
 require File.dirname(__FILE__) + '/authentication'
 
-require 'faster_csv'
+require "csv" # faster_csv (ruby 1.9)
 
-lines = FasterCSV.read(File.dirname(__FILE__) + '/guidebooks.csv') # Exported an Excel file as CSV
+lines = CSV.read(File.dirname(__FILE__) + '/guidebooks.csv') # Exported an Excel file as CSV
 
 lines.slice!(0) # remove header line
 
-klass = StorageRoom.class_for_name('Guidebook')
+collection = StorageRoom::Collection.find('4ddaf68b4d085d374a000003')
+klass = collection.entry_class
 
 lines.each do |row|
   guidebook = klass.new(:title => row[0], :price => row[1].to_f)

data/examples/search_entries.rb

@@ -2,12 +2,12 @@
 
 require File.dirname(__FILE__) + '/authentication'
 
-collection = StorageRoom::Collection.find('guidebooks')
+collection = StorageRoom::Collection.find('4ddaf68b4d085d374a000003')
 
-entries = collection.entry_class.search(:title => 'Name 2')
+entries = collection.entry_class.search(:title => 'Hitchhikers Guide to the Galaxy')
 
-puts "Entries with title 'Name 2':"
+puts "Entries with title 'Hitchhikers Guide to the Galaxy':"
 
 entries.resources.each do |entry|
-  puts "- #{entry[:title]}"
+  puts "- #{entry[:title]} : #{entry.url}"
 end

data/examples/update_entry.rb

@@ -2,7 +2,7 @@
 
 require File.dirname(__FILE__) + '/authentication'
 
-collection = StorageRoom::Collection.find('guidebooks')
+collection = StorageRoom::Collection.find('4ddaf68b4d085d374a000003')
 
 entry = collection.entries.resources.first
 

data/lib/storage_room.rb

@@ -72,10 +72,12 @@ module StorageRoom
     end
     
     # Return a Ruby class for a StorageRoom type
-    def class_for_name(name)        
-      if StorageRoom.const_defined?(name)  
+    def class_for_name(name) 
+      is_ruby_19 = method(:const_defined?).arity == 1 # ruby 1.9 check
+      
+      if is_ruby_19 ? StorageRoom.const_defined?(name)  : StorageRoom.const_defined?(name, false)
         "StorageRoom::#{name}".constantize
-      elsif Object.const_defined?(name)
+      elsif is_ruby_19 ? Object.const_defined?(name) : Object.const_defined?(name, false)
         name.constantize
       else
         klass = Class.new(Entry) 

data/lib/storage_room/base.rb

@@ -33,7 +33,7 @@ module StorageRoom
         object = case type
           when 'Array' then Array.new
           when 'Collection' then Collection.new
-          else
+          else # entry
             StorageRoom.class_for_name(type.classify).new
         end
         
@@ -58,6 +58,10 @@ module StorageRoom
     def url
       self[:@url]
     end
-
+    
+    def version
+      self[:@version]
+    end
+    
   end
 end

data/lib/storage_room/model.rb

@@ -97,7 +97,7 @@ module StorageRoom
     end
     
     def as_json(args = {}) # :nodoc:
-      {self.class.json_name => self.attributes.reject{|k, v| self.class.meta_data?(k)}}
+      {self.class.json_name => self.attributes.reject{|k, v| self.class.meta_data?(k) && k.to_s != '@version'}}
     end
     
     # The validation errors that were returned by the server

data/lib/storage_room/models/collection.rb

@@ -26,7 +26,7 @@ module StorageRoom
     
     # The class of the collection's objects
     def entry_class
-      StorageRoom.class_for_name(self[:identifier].classify)
+      StorageRoom::Entry.class_with_options(self[:name].classify, :collection_path => self.url)
     end
 
     

data/lib/storage_room/models/entry.rb

@@ -1,22 +1,26 @@
 module StorageRoom
   class Entry < Model
-    class << self                  
-      def index_path # :nodoc:
-        "/collections/#{collection_id}/entries" 
+    class_inheritable_accessor :collection_path
+    
+    class << self   
+      def class_with_options(name, options = {})
+        # TODO_SK: check options
+        
+        klass = StorageRoom.class_for_name(name)
+        
+        klass.collection_path = options[:collection_path]
+        
+        klass
       end
       
+      def index_path
+        "#{collection_path}/entries"
+      end
+            
       def show_path(entry_id) # :nodoc:
         "#{index_path}/#{entry_id}"
       end
-      
-      def collection_path # :nodoc:
-        "/collections/#{collection_id}"
-      end
-      
-      def collection_id # :nodoc:
-        self.name.gsub('StorageRoom::', '').tableize
-      end
-      
+            
       def json_name # :nodoc:
         'entry'
       end

data/spec/fixtures/collection.json

@@ -2,8 +2,9 @@
     "collection": {
         "name": "Guidebooks",
         "@updated_at": "2010-11-05T12:55:04Z",
-        "@entries_url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/guidebooks/entries",
+        "@entries_url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/4ddaf68b4d085d374a000003/entries",
         "@created_at": "2010-09-14T20:01:13Z",
+        "@version": 2,
         "fields": [{
             "name": "Title",
             "required": true,
@@ -32,7 +33,6 @@
             "identifier": "location"
         }],
         "@type": "Collection",
-        "@url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/guidebooks",
-        "identifier": "guidebooks"
+        "@url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/4ddaf68b4d085d374a000003"
     }
 }

data/spec/fixtures/collections.json

@@ -5,8 +5,9 @@
         "resources": [{
             "name": "Guidebooks",
             "@updated_at": "2010-11-05T12:55:04Z",
-            "@entries_url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/guidebooks/entries",
+            "@entries_url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/4ddaf68b4d085d374a000003/entries",
             "@created_at": "2010-09-14T20:01:13Z",
+            "@version": 2,
             "fields": [{
                 "name": "Title",
                 "required": true,
@@ -35,8 +36,7 @@
                 "identifier": "location"
             }],
             "@type": "Collection",
-            "@url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/guidebooks",
-            "identifier": "guidebooks"
+            "@url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/4ddaf68b4d085d374a000003"
         }]
     }
 }

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'storage_room'
-require 'spec'
-require 'spec/autorun'
+# require 'spec'
+# require 'spec/autorun'
 require 'webmock/rspec'
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.include WebMock::API
   
   config.before(:each) do

data/spec/storage_room/base_spec.rb

@@ -104,6 +104,14 @@ describe StorageRoom::Base do
       end
     end
     
+    describe "#version" do
+      it "should return version" do
+        @base.version.should be_nil
+        @base[:@version] = 1
+        @base.version.should == 1
+      end
+    end
+    
 
   end
   

data/spec/storage_room/model_spec.rb

@@ -175,20 +175,22 @@ describe StorageRoom::Model do
 
      describe "#create" do
        it "should create" do
-         klass = StorageRoom.class_for_name('Guidebook')
+         collection_path = '/collections/4ddaf68b4d085d374a000003'
+         klass = StorageRoom::Entry.class_with_options('Guidebook', :collection_path => collection_path)
          guidebook = klass.new
 
-         stub_request(:post, stub_url('/collections/guidebooks/entries')).to_return(:body => fixture_file('collection.json'), :status => 200)
+         stub_request(:post, stub_url(klass.index_path)).to_return(:body => fixture_file('collection.json'), :status => 200)
 
          guidebook.create
          guidebook[:name].should == 'Guidebooks'
        end
 
        it "should have errors on validation error" do
-         klass = StorageRoom.class_for_name('Guidebook')
+         collection_path = '/collections/4ddaf68b4d085d374a000003'
+         klass = StorageRoom::Entry.class_with_options('Guidebook', :collection_path => collection_path)
          guidebook = klass.new
 
-         stub_request(:post, stub_url('/collections/guidebooks/entries')).to_return(:body => fixture_file('validation_error.json'), :status => 422)
+         stub_request(:post, stub_url('/collections/4ddaf68b4d085d374a000003/entries')).to_return(:body => fixture_file('validation_error.json'), :status => 422)
 
          guidebook.create
          guidebook[:name].should be_nil

data/spec/storage_room/models/collection_spec.rb

@@ -44,7 +44,7 @@ describe StorageRoom::Collection do
     
     describe "#entry_class" do
       it "should return class" do
-        @collection[:identifier] = 'guidebook'
+        @collection[:name] = 'guidebook'
         klass = @collection.entry_class
         klass.should == Guidebook
       end

data/spec/storage_room/models/entry_spec.rb

@@ -4,30 +4,30 @@ describe StorageRoom::Entry do
   context "Class" do
     context "Methods" do
       before(:each) do
-        StorageRoom.class_for_name('Guidebook')
+        StorageRoom::Entry.class_with_options('Guidebook', :collection_path => '/collections/4ddaf68b4d085d374a000003')
       end
       
       describe "#show_path" do
         it "should be defined" do
-          Guidebook.show_path(1).should == '/collections/guidebooks/entries/1'
+          Guidebook.show_path(1).should == '/collections/4ddaf68b4d085d374a000003/entries/1'
         end
       end
       
       describe "#index_path" do
         it "should be defined" do
-          Guidebook.index_path.should == '/collections/guidebooks/entries'
+          Guidebook.index_path.should == '/collections/4ddaf68b4d085d374a000003/entries'
         end
       end
       
       describe "#collection_path" do
         it "should be defined" do
-          Guidebook.collection_path.should == '/collections/guidebooks'
+          Guidebook.collection_path.should == '/collections/4ddaf68b4d085d374a000003'
         end
       end
       
       describe "#search_path" do
         it "should be defined" do
-          Guidebook.search_path(:test =>1).should == '/collections/guidebooks/entries?test=1'
+          Guidebook.search_path(:test =>1).should == '/collections/4ddaf68b4d085d374a000003/entries?test=1'
         end
       end
       
@@ -38,12 +38,6 @@ describe StorageRoom::Entry do
         end
       end
       
-      describe "#collection_id" do
-        it "should be defined" do
-          Guidebook.collection_id.should == 'guidebooks'
-        end
-      end
-      
       describe "#search" do
         it "should load" do
           pending

data/storage_room.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{storage_room}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sascha Konietzke"]
-  s.date = %q{2011-01-17}
+  s.date = %q{2011-05-23}
   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 = [
@@ -64,27 +64,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{StorageRoom API Wrapper (ActiveModel style)}
-  s.test_files = [
-    "examples/authentication.rb",
-    "examples/create_entry.rb",
-    "examples/destroy_entry.rb",
-    "examples/get_collections.rb",
-    "examples/import_csv.rb",
-    "examples/search_entries.rb",
-    "examples/update_entry.rb",
-    "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/entry_spec.rb",
-    "spec/storage_room_spec.rb"
-  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: storage_room
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sascha Konietzke
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 +01:00
+date: 2011-05-23 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
         - 1
         - 2
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -56,7 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 0
         - 6
@@ -72,7 +68,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 3
         - 0
@@ -146,7 +141,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -155,7 +149,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -166,23 +159,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: StorageRoom API Wrapper (ActiveModel style)
-test_files: 
-- examples/authentication.rb
-- examples/create_entry.rb
-- examples/destroy_entry.rb
-- examples/get_collections.rb
-- examples/import_csv.rb
-- examples/search_entries.rb
-- examples/update_entry.rb
-- 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/entry_spec.rb
-- spec/storage_room_spec.rb
+test_files: []
+