storage_room 0.1.0

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+lib/irb.rb

data/History.txt

@@ -0,0 +1,3 @@
+=== Version 0.1.0 
+
+* Initial Version

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Thriventures UG (haftungsbeschränkt) - http://thriventures.com
+
+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.rdoc

@@ -0,0 +1,51 @@
+== StorageRoom Gem
+
+This gem provides read and write access to the StorageRoom API (http://storageroomapp.com). It has an ActiveRecord/ActiveModel like interface.
+
+
+== Installation
+
+To install the library execute:
+
+  sudo gem install storage_room
+
+
+== Basic Usage
+
+This is a walkthrough with all steps you need to setup a devise resource, including model, migration, route files, and optional configuration.
+  
+  StorageRoom.authenticate(YOUR_ACCOUNT_ID, YOUR_APPLICATION_API_KEY)
+  collection = StorageRoom::Collection.find('guidebooks')
+  
+  resources = collection.resources
+  resource = resources.items.first
+  
+  resource[:name] = 'Foobar'
+  
+  if resource.save
+    puts "Resource saved."
+  else
+    puts "Could not save Resource: #{resource.errors.join(', )}"
+  end
+
+== More Examples
+
+See the examples folder.
+
+== TODO
+
+Please refer to TODO file.
+
+== Maintainers
+
+* Sascha Konietzke 
+
+== Bugs and Feedback
+
+If you discover any bugs, please create an issue on GitHub.
+
+http://github.com/thriventures/storage_room_gem/issues
+
+== License
+
+MIT License. Copyright 2010 Thriventures UG (haftungsbeschränkt) - http://www.thriventures.com

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "storage_room"
+    gem.summary = %Q{StorageRoom API Wrapper (ActiveModel style)}
+    gem.description = %Q{StorageRoom is a CMS system for Mobile Applications (iPhone, Android, BlackBerry, ...). This library gives you an ActiveModel-like interface to your data.}
+    gem.email = "sascha@thriventures.com"
+    gem.homepage = "http://github.com/thriventures/storage_room_gem"
+    gem.authors = ["Sascha Konietzke"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "webmock"
+    
+    gem.add_dependency 'httparty', '>= 0.6.1'
+    gem.add_dependency 'activesupport', '>= 3.0.0'
+    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+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
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "storage_room #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,9 @@
+- rdoc
+- gemcutter
+
+
+
+== Version X
+
+- have collection fields
+- executable/cli

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/authentication.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/../lib/storage_room'
+
+ACCOUNT_ID = '4c8fd48542507175aa00002f' # your account id
+APPLICATION_API_KEY = '43ruv6DDcNYlPZ5xH7en' # your application's API key with read/write access
+
+StorageRoom.authenticate(ACCOUNT_ID, APPLICATION_API_KEY)

data/examples/create_resource.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/authentication'
+
+# create a resource without fetching the collection
+klass = StorageRoom.class_for_name('Guidebook')
+resource1 = klass.new(:name => 'Foo', :price => 1.23)
+
+if resource1.save
+  puts "Resource saved"
+else
+  puts "Resource could not be saved: #{resource1.errors.join(', ')}"
+end
+
+# fetch the collection first
+collection = StorageRoom::Collection.find('guidebooks')
+
+resource2 = collection.resource_class.new(:name => 'Bar', :price => 2.23)
+
+if resource2.save
+  puts "Resource saved"
+else
+  puts "Resource could not be saved: #{resource2.errors.join(', ')}"
+end

data/examples/destroy_resource.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/authentication'
+
+collection = StorageRoom::Collection.find('guidebooks')
+
+resource = collection.resources.items.first
+
+resource.destroy
+
+puts "Destroyed #{resource[:name]}"

data/examples/get_collections.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/authentication'
+
+collections = StorageRoom::Collection.all
+
+puts "Collections:"
+
+collections.items.each do |collection|
+  puts "- #{collection[:name]}"
+end

data/examples/guidebooks.csv

@@ -0,0 +1,21 @@
+"Name","Price"
+"Name 1",1.1
+"Name 2",2.1
+"Name 3",3.1
+"Name 4",4.1
+"Name 5",5.1
+"Name 6",6.1
+"Name 7",7.1
+"Name 8",8.1
+"Name 9",9.1
+"Name 10",10.1
+"Name 11",11.1
+"Name 12",12.1
+"Name 13",13.1
+"Name 14",14.1
+"Name 15",15.1
+"Name 16",16.1
+"Name 17",17.1
+"Name 18",18.1
+"Name 19",19.1
+"Name 20",20.1

data/examples/import_csv.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/authentication'
+
+require 'faster_csv'
+
+lines = FasterCSV.read(File.dirname(__FILE__) + '/guidebooks.csv') # Exported an Excel file as CSV
+
+lines.slice!(0) # remove header line
+
+klass = StorageRoom.class_for_name('Guidebook')
+
+lines.each do |row|
+  guidebook = klass.new(:name => row[0], :price => row[1].to_f)
+
+  if guidebook.save
+    puts "Guidebook saved: #{guidebook[:name]}, #{guidebook[:price]}"
+  else
+    puts "Guidebook could not be saved: #{guidebook.errors.join(', ')}"
+  end
+end

data/examples/search_resources.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/authentication'
+
+collection = StorageRoom::Collection.find('guidebooks')
+
+resources = collection.resource_class.search(:name => 'Bar')
+
+puts "Resources with name 'Bar':"
+
+resources.items.each do |resource|
+  puts "- #{resource[:name]}"
+end

data/examples/update_resource.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/authentication'
+
+collection = StorageRoom::Collection.find('guidebooks')
+
+resource = collection.resources.items.first
+
+resource[:name] = 'Foobar'
+
+if resource.save
+  puts "Resource saved"
+else
+  puts "Resource could not be saved: #{resource.errors.join(', ')}"
+end

data/lib/storage_room/array.rb

@@ -0,0 +1,64 @@
+module StorageRoom
+  class Array < Base
+    attr_accessor :items
+    
+    class << self      
+
+    end
+    
+    
+    def initialize(attributes = {})
+      self.items = []
+      super
+    end
+    
+    def set_from_api(attributes)
+      super(attributes)
+                  
+      self.items = attributes['items'].map{|item| self.class.create_from_api(item)} # transform hashes to real objects
+      attributes.delete('items')  
+    end
+    
+    def reset!
+      super
+      @items = []
+    end
+    
+    def load_next_page!
+      if self[:@next_page].present?
+        reload(self[:@next_page]) 
+        true
+      else
+        false
+      end
+    end
+    
+    # Replace the Collection with the privious page of elements if there is one
+    def load_previous_page!
+      if self[:@previous_page].present?
+        reload(self[:@previous_page]) 
+        true
+      else
+        false
+      end    
+    end
+    
+    
+    # Iterate over all pages
+    def each_page(args={})
+      begin
+        yield(self)
+      end while(args[:reverse] == true ? load_previous_page! : load_next_page!)
+    end
+    
+    # Iterate over all items with pagination
+    def each_page_each_item(args={})
+      self.each_page(args) do |page|
+        page.items.each do |item|
+          yield(item)
+        end
+      end
+    end
+        
+  end
+end

data/lib/storage_room/attributes.rb

@@ -0,0 +1,37 @@
+module StorageRoom
+  module Attributes
+    def initialize(attributes={})     
+      self.attributes = attributes
+    end
+    
+    def set_from_api(attributes)
+      reset!
+      
+      self.attributes = attributes
+    end
+        
+    def [](name)
+      self.attributes[name]
+    end
+    
+    def []=(name, value)
+      self.attributes[name] = value
+    end
+    
+    def attributes
+      @attributes ||= Hash.new.with_indifferent_access
+    end
+    
+    def attributes=(hash = {})
+      hash.each do |k, v|
+        self.attributes[k] = v
+      end
+    end
+    
+    def reset!
+      @attributes = Hash.new.with_indifferent_access
+    end
+    
+  end
+  
+end

data/lib/storage_room/base.rb

@@ -0,0 +1,56 @@
+module StorageRoom
+  class Base
+    include Attributes
+    include HTTParty
+    
+    headers 'User-Agent' => 'StorageRoom Ruby Gem', 'Accept' => 'application/json', 'Content-Type' => 'application/json'
+    format :json
+
+    
+    class << self
+      def load(url, parameters = {})
+        httparty = get(url, parameters)
+        
+        handle_critical_response_errors(httparty)
+        create_from_api(httparty.parsed_response.first[1])
+      end
+      
+      def handle_critical_response_errors(httparty)
+        case httparty.response.code
+          when '200', '201', '422' then true
+          else
+            raise StorageRoom::RequestFailed.new("Invalid HTTP Response: #{httparty.response.code}")
+        end
+      end
+      
+      def create_from_api(hash) 
+        type = hash['@type']
+        
+        object = case type
+          when 'Array' then Array.new
+          when 'Collection' then Collection.new
+          else
+            StorageRoom.class_for_name(type).new
+        end
+        
+        object.set_from_api(hash)
+        object
+      end
+            
+      def meta_data?(key)
+        key[0...1] == '@'
+      end            
+    end
+    
+    def reload(url = nil, parameters = {})
+      httparty = self.class.get(url || self[:@url], parameters)
+      set_from_api(httparty.parsed_response.first[1])
+      true
+    end
+            
+    def url
+      self[:@url]
+    end
+
+  end
+end

data/lib/storage_room/embedded.rb

@@ -0,0 +1,6 @@
+module StorageRoom
+  class Embedded
+    include Attributes
+    
+  end
+end

data/lib/storage_room/embeddeds/file.rb

@@ -0,0 +1,5 @@
+module StorageRoom
+  class File < Embedded
+    
+  end
+end

data/lib/storage_room/embeddeds/location.rb

@@ -0,0 +1,5 @@
+module StorageRoom
+  class Location < Embedded
+    
+  end
+end

data/lib/storage_room/field.rb

@@ -0,0 +1,7 @@
+module StorageRoom
+  class Field
+
+    
+    
+  end
+end

data/lib/storage_room/model.rb

@@ -0,0 +1,111 @@
+module StorageRoom
+  class Model < Base
+    class << self
+      def create(attributes={})
+        resource = new(attributes)
+        resource.create
+        resource
+      end
+      
+      def all
+        load(index_path)
+      end
+      
+      def find(id)
+        load(show_path(id))
+      end
+            
+      def index_path
+        raise StorageRoom::AbstractMethod.new
+      end
+      
+      def show_path(id)
+        raise StorageRoom::AbstractMethod.new
+      end
+      
+      def json_name
+        raise StorageRoom::AbstractMethod.new
+      end
+    end
+    
+    def initialize(attributes={})     
+      @new_record = true
+      @errors = []
+      
+      super
+    end
+    
+    def set_from_api(attributes)
+      super
+      @new_record = false
+      
+      self.attributes
+    end
+    
+    def reset!
+      super
+      @new_record = true
+      @errors = []
+      true
+    end
+    
+    def new_record?
+      @new_record ? true : false
+    end
+    
+    def save
+      new_record? ? create : update
+    end
+    
+    def create
+      return false unless new_record?
+      httparty = self.class.post(self.class.index_path, :body => to_json)
+      handle_save_response(httparty)
+    end
+    
+    def update
+      return false if new_record?
+      httparty = self.class.put(url, :body => to_json)
+      handle_save_response(httparty)
+    end
+    
+    def destroy
+      return false if new_record?
+      
+      httparty = self.class.delete(url)
+      self.class.handle_critical_response_errors(httparty)
+      
+      true
+    end
+    
+    def valid?
+      self.errors.empty?
+    end
+    
+    def as_json(args = {})
+      {self.class.json_name => self.attributes.reject{|k, v| self.class.meta_data?(k)}}
+    end
+    
+    def errors
+      @errors ||= []
+    end
+    
+    # ===================
+    # = Private Methods =
+    # ===================
+    
+    private
+      def handle_save_response(httparty)
+        self.class.handle_critical_response_errors(httparty)
+        
+        if httparty.response.code == '200' || httparty.response.code == '201'
+          self.set_from_api(httparty.parsed_response.first[1])
+          true
+        else
+          @errors = httparty.parsed_response['error']['message']
+          false
+        end
+      end
+      
+  end
+end

data/lib/storage_room/models/collection.rb

@@ -0,0 +1,31 @@
+module StorageRoom
+  class Collection < Model        
+    class << self                  
+      def index_path
+        '/collections'
+      end
+      
+      def show_path(collection_id)
+        "#{index_path}/#{collection_id}"
+      end
+      
+      def resources_path(collection_id)
+        "#{show_path(collection_id)}/resources"
+      end
+      
+      def json_name
+        'collection'
+      end
+    end
+    
+    def resources
+      Array.load(self[:@resources_url])
+    end
+    
+    def resource_class
+      StorageRoom.class_for_name(self[:identifier].classify)
+    end
+
+    
+  end
+end

data/lib/storage_room/models/resource.rb

@@ -0,0 +1,53 @@
+module StorageRoom
+  class Resource < Model
+    class << self                  
+      def index_path
+        "/collections/#{collection_id}/resources" 
+      end
+      
+      def show_path(resource_id)
+        "#{index_path}/#{resource_id}"
+      end
+      
+      def collection_path
+        "/collections/#{collection_id}"
+      end
+      
+      def collection_id
+        self.name.gsub('StorageRoom::', '').tableize
+      end
+      
+      def json_name
+        'resource'
+      end
+      
+      def search_path(parameters = {})
+        parameters.present? ? "#{index_path}?#{parameters.to_query}" : index_path
+      end
+      
+      def search(parameters = {})
+        Array.load(search_path(parameters))
+      end
+    end
+    
+    def set_from_api(attributes)
+      super(attributes)
+                  
+      self.attributes.each do |k, v|
+        if v.is_a?(Hash) && v[:@type].present?
+          object = StorageRoom.class_for_name(v[:@type]).new
+          object.set_from_api(v)
+          self.attributes[k] = object
+        end
+      end
+      
+      self.attributes
+    end
+    
+    def collection
+      Collection.load(self[:@collection_url] || self.class.collection_path)
+    end
+    
+
+  end
+end