storage_room 0.3.1 → 0.3.2

data/History.txt

@@ -1,3 +1,6 @@
+=== Version 0.3.2
+* Support for File and Image uploads
+
 === Version 0.3.1
 * Support for ArrayField and JsonField
 

data/README.rdoc

@@ -8,7 +8,7 @@ This gem provides read and write access to the StorageRoom API (http://storagero
 * Automatic creation of Entry Classes from a Collection, you don't have to configure anything
 * Supports lazy-loading of associations (e.g. post.category will fetch a category transparently if it has not yet been loaded)
 * Supports caching through an identity map, so that Resources don't have to be loaded multiple times
-
+* Easy file uploads and removals
 
 == Installation
 

data/Rakefile

@@ -15,6 +15,7 @@ begin
       
     gem.add_dependency 'httparty', '>= 0.6.1'
     gem.add_dependency 'activesupport', '>= 3.0.0'
+    gem.add_dependency 'mime-types'
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/TODO

@@ -1,10 +1,9 @@
 
 
+
 == Version X
 
 - have a gemfile?
 - make on/many only accept objects of correct class?
 - executable/cli
-- file uploads/removals
-  - get files via api
-- look at arguments with identity map  
+- arguments with identity map  

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/examples/upload_remove_image.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.dirname(__FILE__) + '/authentication'
+
+path = ::File.expand_path(File.dirname(__FILE__) + '/../spec/fixtures/image.png')
+collection = StorageRoom::Collection.find('4e034b8db65245b72600002b')
+
+# Upload Image or File
+entry = collection.entry_class.new(:name => "StorageRoom Logo", :image => StorageRoom::Image.new_with_filename(path))
+
+if entry.save 
+  puts "Entry saved (#{entry[:@url]})"
+  puts "URL of the uploaded image is #{entry.image.url}"
+  puts "URL of the automatically generated thumbnail is #{entry.image.url(:thumbnail)}" # Multiple Image Versions can be specified in the interface
+else
+  puts "Entry could not be saved: #{entry.errors.join(', ')}"
+end
+
+# Remove Image or File
+
+entry.image.remove = true
+
+if entry.save
+  puts "The Image of the Entry has been removed"
+else
+  puts "The Image of the Entry could not be removed: #{entry.errors.join(', ')}"
+end

data/lib/storage_room/embeddeds/fields/compound/image_field.rb

@@ -1,6 +1,6 @@
 module StorageRoom
   
   class ImageField < CompoundField
-    
+    many :versions
   end
 end

data/lib/storage_room/embeddeds/file.rb

@@ -1,6 +1,28 @@
+
 module StorageRoom
   # Any file
   class File < Embedded
+    key :filename
+    key :content_type
+    key :data
+    key :remove
     
+    class << self
+      # Create a new File and set attributes from local file
+      def new_with_filename(path)
+        new.tap{|f| f.set_with_filename(path)}
+      end
+    end
+    
+    # Sets the filename, content_type and data attributes from a local filename so that a File can be uploaded through the API
+    def set_with_filename(path)
+      return if path.blank?
+      
+      self.filename = ::File.basename(path)
+      self.content_type = ::MIME::Types.type_for(path).first.content_type
+      self.data = ::Base64.encode64(::File.read(path))
+    end
+    
+
   end
 end

data/lib/storage_room/embeddeds/image.rb

@@ -1,6 +1,28 @@
 module StorageRoom
   # An Image with optional thumbnails
-  class Image < Embedded
+  class Image < File     
+    # Returns all valid ImageVersion identifiers for this Image
+    def version_identifiers
+      self[:@versions].keys
+    end
+    
+    # Returns the URL of an Image or the URL of a version if a string or symbol is passed
+    def url(name = nil)
+      if name
+        if version_identifiers.include?(name.to_s)
+          self[:@versions][name.to_s][:@url]
+        else
+          raise "Invalid Image Version identifier: '#{name}' (must be #{version_identifiers.join(', ')})"
+        end
+      else
+        self[:@url]
+      end
+    end
+    
+    # Are versions of the Image still being processed on the server?
+    def processing?
+      self[:@processing]
+    end
     
   end
 end

data/lib/storage_room/embeddeds/image_version.rb

@@ -0,0 +1,12 @@
+module StorageRoom
+  # Part of an ImageField
+  class ImageVersion < Embedded
+    key :identifier
+    key :format
+    key :resize_mode
+    key :width
+    key :height
+    key :scale
+    
+  end
+end

data/lib/storage_room.rb

@@ -4,6 +4,8 @@ $:.unshift(File.dirname(__FILE__)) unless
 begin; require 'rubygems'; rescue LoadError; end
 
 require 'httparty'
+require 'mime/types'
+require 'base64'
 require 'active_support/all' 
 require 'storage_room/extensions/const_defined'
 
@@ -55,6 +57,7 @@ module StorageRoom
   autoload :File,                     'storage_room/embeddeds/file'
   autoload :Image,                    'storage_room/embeddeds/image'
   autoload :Location,                 'storage_room/embeddeds/location'
+  autoload :ImageVersion,             'storage_room/embeddeds/image_version'
 
 
   class << self
@@ -117,8 +120,8 @@ module StorageRoom
       name_with_mapping = entry_class_for_name(name)
       
       begin
-        if StorageRoom.is_constant_defined?(name)
-          return "StorageRoom::#{name}".constantize
+        if StorageRoom.is_constant_defined?(name_with_mapping)
+          return "StorageRoom::#{name_with_mapping}".constantize
         end
       rescue NameError # could contain spaces etc.
       end

data/spec/storage_room/embeddeds/file_spec.rb

@@ -1,5 +1,44 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe StorageRoom::File do
-
+  before(:each) do
+    @file = StorageRoom::File.new
+    @name = ::File.expand_path(File.dirname(__FILE__) + '/../../fixtures/image.png')
+  end
+  
+  context "Class Methods" do
+    describe "#new_with_filename" do
+      it "return a new file object" do
+        file = StorageRoom::File.new_with_filename(@name)
+        file.should be_an_instance_of(StorageRoom::File)
+        file.content_type.should == 'image/png'
+        file.filename.should == 'image.png'
+        file.data.should == ::Base64.encode64(::File.read(@name))
+      end
+    end
+  end
+  
+  context "Methods" do
+    describe "#set_with_filename" do
+      it "should set with filename" do
+        @file.set_with_filename(@name)
+        
+        @file.content_type.should == 'image/png'
+        @file.filename.should == 'image.png'
+        @file.data.should == ::Base64.encode64(::File.read(@name))
+      end
+      
+      describe "#as_json" do
+        it "should return hash" do
+          @file.set_with_filename(@name)
+          
+          hash = @file.as_json.with_indifferent_access
+          hash[:content_type].should == @file.content_type
+          hash[:filename].should == @file.filename
+          hash[:data].should == @file.data
+        end
+      end
+      
+    end
+  end
 end

data/spec/storage_room/embeddeds/image_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe StorageRoom::Image do
+  before(:each) do
+    @image = StorageRoom::Image.new
+    @image.response_data = {
+      '@type' => 'Image',
+      '@url' => 'URL',
+      '@processing' => false,
+      '@versions' => {
+        'thumbnail' => {
+          '@url' => 'THUMBNAIL_URL'
+        }
+      }
+    }
+  end
+  
+  context "Methods" do
+    describe "#image_versions" do
+      it "should return array" do
+        @image.version_identifiers.should == ['thumbnail']
+      end
+    end
+    
+    describe "#url" do
+      it "should return URL for the image" do
+        @image.url.should == 'URL'
+      end
+      
+      it "should return URL for a version" do
+        @image.url(:thumbnail).should == 'THUMBNAIL_URL'
+      end
+      
+      it "should raise error on invalid version" do
+        lambda {
+          @image.url(:asdf)
+        }.should raise_error
+      end
+    end
+    
+    describe "#processing?" do
+      it "should return true" do
+        @image.response_data['@processing'] = true
+        @image.should be_processing
+      end
+      
+      it "should return false" do
+        @image.response_data['@processing'] = false
+        @image.should_not be_processing
+      end
+    end
+    
+  end
+end

data/spec/storage_room/embeddeds/image_version_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe StorageRoom::ImageVersion do
+  before(:each) do
+    @image_version = StorageRoom::ImageVersion.new(:identifier => 'thumb', :format => 'png', :resize_mode => 'fit', :width => 100, :height => 200)
+  end
+  
+  context "Configuration" do
+    describe "#keys" do
+      it "should have keys" do        
+        @image_version.identifier.should == 'thumb'
+        @image_version.format.should == 'png'
+        @image_version.resize_mode.should == 'fit'
+        @image_version.width.should == 100
+        @image_version.height.should == 200
+      end
+    end
+  end
+end

data/storage_room.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{storage_room}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sascha Konietzke"]
-  s.date = %q{2011-06-22}
+  s.date = %q{2011-07-04}
   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 = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "examples/import_csv.rb",
     "examples/search_entries.rb",
     "examples/update_entry.rb",
+    "examples/upload_remove_image.rb",
     "lib/console.rb",
     "lib/storage_room.rb",
     "lib/storage_room/accessors.rb",
@@ -57,6 +58,7 @@ Gem::Specification.new do |s|
     "lib/storage_room/embeddeds/fields/compound_field.rb",
     "lib/storage_room/embeddeds/file.rb",
     "lib/storage_room/embeddeds/image.rb",
+    "lib/storage_room/embeddeds/image_version.rb",
     "lib/storage_room/embeddeds/location.rb",
     "lib/storage_room/extensions/const_defined.rb",
     "lib/storage_room/identity_map.rb",
@@ -68,6 +70,7 @@ Gem::Specification.new do |s|
     "lib/storage_room/resource.rb",
     "spec/fixtures/collection.json",
     "spec/fixtures/collections.json",
+    "spec/fixtures/image.png",
     "spec/fixtures/validation_error.json",
     "spec/spec_helper.rb",
     "spec/storage_room/accessors_spec.rb",
@@ -92,6 +95,8 @@ Gem::Specification.new do |s|
     "spec/storage_room/embeddeds/fields/compound/location_field_spec.rb",
     "spec/storage_room/embeddeds/fields/compound_field_spec.rb",
     "spec/storage_room/embeddeds/file_spec.rb",
+    "spec/storage_room/embeddeds/image_spec.rb",
+    "spec/storage_room/embeddeds/image_version_spec.rb",
     "spec/storage_room/embeddeds/location_spec.rb",
     "spec/storage_room/identity_map_spec.rb",
     "spec/storage_room/model_spec.rb",
@@ -117,17 +122,20 @@ Gem::Specification.new do |s|
       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"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 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"])
+      s.add_dependency(%q<mime-types>, [">= 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"])
+    s.add_dependency(%q<mime-types>, [">= 0"])
   end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Sascha Konietzke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-22 00:00:00 -03:00
+date: 2011-07-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -75,6 +75,19 @@ dependencies:
         version: 3.0.0
   type: :runtime
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
 description: StorageRoom is a CMS system for Mobile Applications (iPhone, Android, BlackBerry, ...). This library gives you an ActiveModel-like interface to your data.
 email: sascha@thriventures.com
 executables: []
@@ -100,6 +113,7 @@ files:
 - examples/import_csv.rb
 - examples/search_entries.rb
 - examples/update_entry.rb
+- examples/upload_remove_image.rb
 - lib/console.rb
 - lib/storage_room.rb
 - lib/storage_room/accessors.rb
@@ -125,6 +139,7 @@ files:
 - lib/storage_room/embeddeds/fields/compound_field.rb
 - lib/storage_room/embeddeds/file.rb
 - lib/storage_room/embeddeds/image.rb
+- lib/storage_room/embeddeds/image_version.rb
 - lib/storage_room/embeddeds/location.rb
 - lib/storage_room/extensions/const_defined.rb
 - lib/storage_room/identity_map.rb
@@ -136,6 +151,7 @@ files:
 - lib/storage_room/resource.rb
 - spec/fixtures/collection.json
 - spec/fixtures/collections.json
+- spec/fixtures/image.png
 - spec/fixtures/validation_error.json
 - spec/spec_helper.rb
 - spec/storage_room/accessors_spec.rb
@@ -160,6 +176,8 @@ files:
 - spec/storage_room/embeddeds/fields/compound/location_field_spec.rb
 - spec/storage_room/embeddeds/fields/compound_field_spec.rb
 - spec/storage_room/embeddeds/file_spec.rb
+- spec/storage_room/embeddeds/image_spec.rb
+- spec/storage_room/embeddeds/image_version_spec.rb
 - spec/storage_room/embeddeds/location_spec.rb
 - spec/storage_room/identity_map_spec.rb
 - spec/storage_room/model_spec.rb