imager 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef11a3f46f143082a1a0f76416edf5fdb8a17d72
-  data.tar.gz: 540cb3e2fa09528f711339ed4ba55dec8e6ba9a7
+  metadata.gz: d30bc7d9057f78efe90d633324e31852c4c5ca60
+  data.tar.gz: e7dbe1bf69a88703cde2c1e672c396543ba48ba7
 SHA512:
-  metadata.gz: fec4251a3c3f023ed8a5eb1c48396b293843025c7175680807b9d3d9c0b1acb885d2e2c450ae95839652bf565277d46fff3d9b5d09cec569899360f7ef8ceb10
-  data.tar.gz: aa98a48c0d0d5d328b057dd3fe34bbdd48b1b320f42499b05e64750b6716562a0bc1ebba6fdd5c5a343437daf9a6916e3779c7693731bdb3bd6343ab678d0173
+  metadata.gz: e2d3700bf32ccbc0d3e930b8b9472f586b8a909652eff5d5f3f5dd327faf335dcc87bf47243facd0f783595da51210af4b3437da777c03b2ac7aee18ba88c06b
+  data.tar.gz: 2f5a859eb4cb534df31357ddf22510f8e8001f5d6735ef7010bb882851359224862843a731d14c3a02c027971054bc04152c31a25219625a46fff92de4e1f976

data/README.md

@@ -17,7 +17,7 @@ A lot of the features are not implemented yet (except for the server)
 
 Add this line to your application's Gemfile:
 
-    gem 'Imager'
+    gem 'imager'
 
 And then execute:
 
@@ -25,7 +25,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install Imager
+    $ gem install imager
 
 ## Usage
 
@@ -40,41 +40,50 @@ Or install it yourself as:
   This is for post and delete authentication (manager).
 
 ### Sending the images
+
     Imager::ServerInterface.post("Collection", "Album", "test/image.png", small: { width: 100 })
 
 ### Removing the images
+
     Imager::ServerInterface.delete("Collection", "Album", "image")
 
 ### Using the images
+
     Imager::LinkHelper.link_for("Collection", "Album", "image", :small)
+    
 Will return:
     "http://files.myserver.com/images/collection/album/image/small.jpg"
-Since the server ALWAYS save the images as jpg.
+    Since the server ALWAYS save the images as jpg.
 
 You can use Collection as model name(product) and album as id(1) and get the result:
+
     "http://files.myserver.com/images/product/1/image/small.jpg"
   Just save as:
-    Imager::ServerInterface.post("product", "1", "test/image.png", small: { width: 100 })
+    `Imager::ServerInterface.post("product", "1", "test/image.png", small: { width: 100 })`
 
 ## Notes about saving and sizes
   Saving first as `"product", "1", "test/image.png", small: { width: 100 })` and after `"product", "1", "test/otherimage.png", small: { width: 90 })` don't changes the size of image. Beware!
 
 ### Sizes Explain:
   The server accepts the following combinations:
+  
   ```
   YourSizeName: { width:  100 } # Will resize (maintein main aspect) the image for 100px of width
   YourSizeName: { height: 100 } # Will resize (maintein main aspect) the image for 100px of height
   YourSizeName: { width:  100, height: 150 } # Will resize to fit in 100x150 px
-  YourSizeName: { original: true } # Will save the original size. Don't worry. The server compress to 50% of quality.
+  YourSizeName: { original: :original } # Will save the original size. Don't worry. The server compress to 50% of quality.
   ```
+  
   You can have many sizes when posting a image:
+  
   ```
   sizes = [
     small:     { width:  100 }
     gallery:   { height: 300 }
     mini-home: { width: 50, height: 50 }
-    original:  true
+    original: :original
   ]
   ```
+  
 ### Compression
-  The images always are compressed to 70%. Except for the original size (50%).
+  The images always are compressed to 70%. Except for the original size (50%).

data/Rakefile

@@ -1,9 +1 @@
-require "bundler/gem_tasks"
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Run tests"
-  task :default => :test
+require "bundler/gem_tasks"

data/imager.gemspec

@@ -20,5 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_dependency "httmultiparty"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "httmultiparty", "~> 0.3.10"
+  spec.add_dependency "json"
 end

data/lib/imager/imager_error.rb

@@ -0,0 +1,4 @@
+module Imager
+  class ImagerError < ArgumentError
+  end
+end

data/lib/imager/link_helper.rb

@@ -2,7 +2,7 @@ module Imager
   class LinkHelper
     def self.link_for(collection, album, image, size)
       size = size.to_s
-      "#{Imager.base_uri}#{Imager.collection_path}/#{collection}/#{album}/#{image}/#{size}.jpg"
+      "#{Imager.base_uri}/#{Imager.collection_path}/#{collection}/#{album}/#{image}/#{size}.jpg"
     end
   end
 end

data/lib/imager/server_interface.rb

@@ -1,5 +1,6 @@
 require 'openssl'
 require 'cgi'
+require 'json'
 
 module Imager
   class ServerInterface
@@ -23,7 +24,7 @@ module Imager
       query[:file_id]    = file_id
       query[:auth]       = auth_token(query)
 
-      return parse(client.post('/delete.php', { query: query }))
+      return parse(client.post('/delete.php', { query: query }), true)
     end
 
     def self.client
@@ -35,22 +36,43 @@ module Imager
 
     private
 
-    def self.parse(response)
+    def self.parse(response, is_delete = false)
       case response.code
-      when 200..299
+      when 204
         return true
+      when 200..299
+        parsed =  begin
+                    !!JSON.parse(response.body)
+                  rescue
+                    false
+                  end
+
+        return true if parsed
+        # Something is wrong with the server
+        raise ArgumentError, "The server send an invalid response.", caller
       when 400
-        raise ArgumentError, response.body, caller
+        raise ImagerError, response.body, caller
+      when 404
+        # We are deleting something that doesn't exist
+        if (is_delete && response.body == "Cannot find the file.")
+          raise ImagerError, response.body, caller
+        else
+          raise ArgumentError, "The server return an unexpected 404.", caller
+        end
       when 401
-        raise Error, "Authentication failed."
+        # Authentication with the server failed
+        raise ArgumentError, "Authentication failed: " + response.body, caller
       else
-        raise Error, "The server returned an error."
+        raise ArgumentError, "The server returned an error: " + response.body, caller
       end
     end
 
     def self.auth_token(query, file=nil)
       query_hash = query.clone
       if file
+        if !File.file?(file)
+          raise ImagerError, "Invalid image file", caller
+        end
         query_hash[:file_md5]   = Digest::MD5.file(file)
         query_hash[:file_sha1]  = Digest::SHA1.file(file)
         query_hash[:file_name]  = File.basename(file)

data/lib/imager/version.rb

@@ -1,3 +1,3 @@
 module Imager
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/imager.rb

@@ -2,7 +2,7 @@ require "imager/version"
 require "imager/server_client"
 require "imager/server_interface"
 require "imager/link_helper"
-
+require "imager/imager_error"
 module Imager
 
   class << self

data/spec/imager/link_helper_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Imager::LinkHelper do
+  describe ".link_for" do
+    it "returns a correct link" do
+      Imager.configure do |c|
+        c.base_uri = "http://base_uri"
+        c.collection_path = "images"
+      end
+
+      correct_link = "http://base_uri/images/testcollection/1/image/small.jpg"
+      result = described_class.link_for("testcollection", "1", "image", :small)
+
+      result.should eq correct_link
+    end
+  end
+end

data/spec/imager/server_interface_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'debugger'
+describe Imager::ServerInterface do
+  describe ".post" do
+
+    context "when params are valid" do
+      it "returns true" do
+        described_class.post("test", "1", "spec/image.jpg", small: { width: 100 }).should be_true
+      end
+    end
+
+    context "when some param is not correct" do
+      it "raises an error" do
+        expect {
+          described_class.post("", "", "", size: { width: 100 })
+        }.to raise_error Imager::ImagerError
+      end
+    end
+  end
+
+  describe ".delete" do
+    context "valid params and existing image" do
+
+      it "returns true" do
+        described_class.post("test", "1", "spec/image.jpg", small: { width: 100 })
+        described_class.delete("test", "1", "image").should be_true
+      end
+    end
+
+    context "some invalid param" do
+      it "raises an error" do
+        expect {
+          described_class.delete("test", "1", "non_existing_image")
+        }.to raise_error Imager::ImagerError
+      end
+    end
+  end
+end

data/spec/imager_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Imager do
+  describe ".configure" do
+
+    it "yields" do
+      described_class.configure do |c|
+        c.should be described_class
+      end
+    end
+
+    it "sets server_uri" do
+      described_class.configure do |c|
+        c.base_uri = "http://baseuri.bla/"
+      end
+
+      described_class.base_uri.should eq "http://baseuri.bla/"
+    end
+
+    it "sets manager_path" do
+      described_class.configure do |c|
+        c.manager_path = "manager_path"
+      end
+
+      described_class.manager_path.should eq "manager_path"
+    end
+
+    it "sets collection_path" do
+      described_class.configure do |c|
+        c.collection_path = "your_collections_path"
+      end
+
+      described_class.collection_path.should eq "your_collections_path"
+    end
+
+    it "sets auth_code" do
+      described_class.configure do |c|
+        c.auth_code = "your_auth_code"
+      end
+
+       described_class.auth_code.should eq "your_auth_code"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'imager'
+
+RSpec.configure do |c|
+  c.before do
+    Imager.configure do |c|
+      c.base_uri        = "http://dev.local/imagerserver"
+      c.auth_code       = "f8cecac2459d83eb9c8c703663e349ddbeb82a76230c7ca5ffc8434cfaab"
+      c.collection_path = "images"
+      c.manager_path    = "manager"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imager
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Guilherme Otranto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-01 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,8 +38,36 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.10
+- !ruby/object:Gem::Dependency
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -66,12 +94,16 @@ files:
 - Rakefile
 - imager.gemspec
 - lib/imager.rb
+- lib/imager/imager_error.rb
 - lib/imager/link_helper.rb
 - lib/imager/server_client.rb
 - lib/imager/server_interface.rb
 - lib/imager/version.rb
-- test/image.jpg
-- test/test_imager.rb
+- spec/image.jpg
+- spec/imager/link_helper_spec.rb
+- spec/imager/server_interface_spec.rb
+- spec/imager_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/guilherme-otran/Imager
 licenses:
 - MIT
@@ -97,5 +129,8 @@ signing_key:
 specification_version: 4
 summary: Imager Client API
 test_files:
-- test/image.jpg
-- test/test_imager.rb
+- spec/image.jpg
+- spec/imager/link_helper_spec.rb
+- spec/imager/server_interface_spec.rb
+- spec/imager_spec.rb
+- spec/spec_helper.rb

data/test/test_imager.rb

@@ -1,118 +0,0 @@
-require 'test/unit'
-require 'imager'
-
-
-class ImagerTest < Test::Unit::TestCase
-  def your_base_uri;         "http://dev.local/imagerserver/"; end;
-  def your_manager_path;     "manager"; end;
-  def your_collections_path; "images"; end;
-  def your_auth_code;        "f8cecac2459d83eb9c8c703663e349ddbeb82a76230c7ca5ffc8434cfaab"; end;
-
-  def test_configure
-    Imager.configure do |c|
-      assert_equal c, Imager
-    end
-  end
-
-  def test_set_server_uri
-    Imager.configure do |c|
-      c.base_uri = your_base_uri
-    end
-
-    assert_equal your_base_uri, Imager.base_uri
-  end
-
-  def test_set_manager_path
-    Imager.configure do |c|
-      c.manager_path = your_manager_path
-    end
-
-    assert_equal your_manager_path, Imager.manager_path
-  end
-
-  def test_set_collection_path
-    Imager.configure do |c|
-      c.collection_path = your_collections_path
-    end
-
-    assert_equal your_collections_path, Imager.collection_path
-  end
-
-  def test_set_auth_code
-    Imager.configure do |c|
-      c.auth_code = your_auth_code
-    end
-
-    assert_equal your_auth_code, Imager.auth_code
-  end
-
-  def test_valid_post_image
-    Imager.configure do |c|
-      c.base_uri = your_base_uri
-      c.auth_code = your_auth_code
-      c.collection_path = your_collections_path
-      c.manager_path = your_manager_path
-    end
-
-    response = Imager::ServerInterface.post("testcollection", "1", "test/image.jpg", small: { width: 100 })
-    assert_equal true, response
-  end
-
-  def test_invalid_post_image
-    response = true
-    begin
-      Imager.configure do |c|
-        c.base_uri = your_base_uri
-        c.auth_code = your_auth_code
-        c.collection_path = your_collections_path
-        c.manager_path = your_manager_path
-      end
-      Imager::ServerInterface.post("", "", "test/image.jpg", small: { width: 100 })
-    rescue
-      response = false
-    end
-    assert_equal false, response
-  end
-
-  def test_valid_delete_image
-    Imager.configure do |c|
-      c.base_uri = your_base_uri
-      c.auth_code = your_auth_code
-      c.collection_path = your_collections_path
-      c.manager_path = your_manager_path
-    end
-
-    response = Imager::ServerInterface.delete("testcollection", "1", "image")
-    assert_equal true, response
-  end
-
-  def test_invalid_delete_image
-    response = true
-    begin
-      Imager.configure do |c|
-        c.base_uri = your_base_uri
-        c.auth_code = your_auth_code
-        c.collection_path = your_collections_path
-        c.manager_path = your_manager_path
-      end
-      Imager::ServerInterface.delete("testcollection", "1", "non_existing_image")
-    rescue
-      response = false
-    end
-    assert_equal false, response
-  end
-
-  def test_link_helper
-      Imager.configure do |c|
-        c.base_uri = your_base_uri
-        c.auth_code = your_auth_code
-        c.collection_path = your_collections_path
-        c.manager_path = your_manager_path
-      end
-
-      result = Imager::LinkHelper.link_for("testcollection", "1", "image", :small)
-      should_be = "#{your_base_uri}#{your_collections_path}/testcollection/1/image/small.jpg"
-
-      assert_equal should_be, result
-  end
-end