rhogallery 0.0.1 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rhogallery (0.0.1)
+    rhogallery (0.1.0)
       json (~> 1.5.4)
       rest-client (~> 1.6.6)
 

data/README.markdown

@@ -1,36 +1,36 @@
-Rhogallery API
+RhoGallery API
 ==================
-##Instaling
+##Getting Started
 
 This is a ruby interface to connect with the rhohub rhogallery api. 
 
 	$ gem install rhogallery
 
-	require 'rhogallery-api'
+	require 'rhogallery'
 
-##Rhogallery Credentials
+##RhoGallery Credentials
 
-First of all you need to set your rhogallery credentials (username and rhogallery token):
+First of all you need to set your RhoGallery credentials (username and rhogallery token):
 
-	RhoGalleryApi.credentials = {:username => YOUR_RHOHUB_USERNAME, :token => YOUR_RHOHUB_TOKEN}
+	RhoGallery.credentials = {:username => YOUR_RHOHUB_USERNAME, :token => YOUR_RHOHUB_TOKEN}
 
 Also, you can see your credentials any time with:
 
-	RhoGalleryApi.credentials
+	RhoGallery.credentials
 	=> {:username => YOUR_RHOHUB_USERNAME, :token => YOUR_RHOHUB_TOKEN}
 
-##Rhogallery Resources
+##RhoGallery Resources
 
 Then you have two classes that you can work with: `RhoGallery::Consumer` and `RhoGallery::Group`
 
-	RhoGalleryApi # Rhogallery Api Defaults configurations
+	RhoGallery # Rhogallery main module
 	
 	RhoGallery::Consumer 
 	RhoGallery::Group
 		
-	  create_new(data, options) #create a new consumer/group
-	  update(data, options)     #use this method to update data
-	  delete(data, options)     #to delete a consumer/group
+	  create(data, options) 	# create a new consumer/group
+	  update(data, options)     # use this method to update data
+	  delete(data, options)     # to delete a consumer/group
 
 * data: consumer or group data, for example: name, cell, login, email. By default takes the data hash takes the attributes 
 	added when is creating the instance ( RhoGallery::Group.new( {:name => "some group name" }) ).
@@ -57,7 +57,7 @@ You can get all your consumers and groups like this:
 
 or if you want to find a consumer/group by id you can do this:
 
-	RhoGallery::Consumer.find_by_id("some_consumer_id")
+	RhoGallery::Consumer.find("some_consumer_id")
 	=> {"name":"John Doe","devices":["ios","android","blackberry"],"deactivated_id":null,
 			"created_at":"2011-01-14T17:49:42Z","cell":"+555555",
 			"updated_at":"2011-06-21T21:14:12Z",
@@ -65,7 +65,7 @@ or if you want to find a consumer/group by id you can do this:
 			"login":"john","invited":true,
 			"email":"john@doe.com","active":true}
 
-	RhoGallery::Group.find_by_id("some_group_id")
+	RhoGallery::Group.find("some_group_id")
 	=> {"name":"rhomobile","created_at":"2011-01-14T15:37:42Z","updated_at":"2011-01-14T15:37:42Z",
 			"id":"4d306dc697fcc274a6000009","active":true}
 
@@ -78,22 +78,22 @@ You can create new groups and consumers with your own attributes and then save i
 	})
 	=> #<RhoGallery::Consumer:0x1018881a8 @attributes={:login => "some_login", :name => "some name", :cell => "+55555", :email => "email@email.com"}>
 	
-	consumer.create_new
+	consumer.save
 	=> true
 	
 	group = RhoGallery::Group.new({:name => "new_group_name"})
 	=> #<RhoGallery::Group:0x1018881b6 @attributes={:name=>"new_group_name"}>
 	
-	group.create_new
+	group.save
 	=> true
 
-or send it the data on the `create_new` method is called
+or send the data directly when `create` method is called
 
 	consumer = RhoGallery::Consumer.new
 	=> #<RhoGallery::Consumer:0x1018881a8 @attributes={:cell=>"+55555", :email=>"email@email.com", 
 			:login=>"some_login",:tags=>"", :password=>"", :name=>"hello", :id=>"4e60ffd4bdd0c8048c000001"}>
 			
-	consumer.create_new({
+	consumer.create({
 		:login => "some_login", :name => "some name", :cell => "+55555", :email => "email@email.com"
 	})
 	=> true
@@ -102,7 +102,7 @@ or send it the data on the `create_new` method is called
 
 Also you can update your consumers and groups fields with the `update`
 
-	consumer = RhoGallery::Consumer.find_by_id("4e60ffd4bdd0c8048c000001")
+	consumer = RhoGallery::Consumer.find("4e60ffd4bdd0c8048c000001")
 	=> #<RhoGallery::Consumer:0x1018881a8 @attributes={:cell=>"some_cell_phone", :invited=>false, :email=>"email@email.com", 
 			:login=>"some_login",:tags=>"", :password=>"", :name=>"hello", :id=>"4e60ffd4bdd0c8048c000001"}>
 
@@ -114,7 +114,7 @@ Also you can update your consumers and groups fields with the `update`
 
 and you can delete it too :)
 
-	consumer = RhoGallery::Consumer.find_by_id("4e60ffd4bdd0c8048c000001")
+	consumer = RhoGallery::Consumer.find("4e60ffd4bdd0c8048c000001")
 	=> #<RhoGallery::Consumer:0x1018881a8 @attributes={:cell=>"new cell phone", :invited=>false, :email=>"email@email.com", 
 			:login=>"new_login",:tags=>"", :password=>"", :name=>"hello", :id=>"4e60ffd4bdd0c8048c000001"}>
 
@@ -123,11 +123,11 @@ and you can delete it too :)
 
 ##See Errors
 
-you can see the errors when the create_new and update methods returns false, with errors method. Example
+You can see the errors when the `create` and `update` methods return false, using the errors method. For example:
 
 	group = RhoGallery::Group.new
 	=> #<RhoGallery::Group:0x1018881c7 @attributes={:name => ""}>
-	group.create_new
+	group.save
 	=> false
 	
 	group.errors

data/init.rb

@@ -1 +1 @@
-require 'rhogallery-api'
+require 'rhogallery'

data/lib/{rhogallery-api → rhogallery}/base.rb

@@ -19,7 +19,7 @@ class RhoGallery::Base
     @attributes
   end
   
-  def create_new(data, options, resource)
+  def create(data, options, resource)
     begin
       RestClient.post RhoGallery.resource_url(options[:username], resource), data, {:Authorization => options[:token]}
       @errors = String.new
@@ -46,12 +46,16 @@ class RhoGallery::Base
     true
   end
   
+  def save(data, options, resource)
+    self.id ? update(data, options, "#{resource}/#{self.id}") : create(data, options, resource)
+  end
+  
   def self.find_all(options, resource)
     res = RestClient::Resource.new(RhoGallery.resource_url(options[:username], "#{resource}"), :headers => {:Authorization => options[:token]})
     JSON.parse res.get
   end
 
-  def self.find_by_id(id, options, resource)
+  def self.find(id, options, resource)
     res = RestClient::Resource.new(RhoGallery.resource_url(options[:username], "#{resource}/#{id}"), :headers => {:Authorization => options[:token]})
     JSON.parse res.get
   end

data/lib/{rhogallery-api → rhogallery}/consumer.rb

@@ -1,12 +1,16 @@
 class RhoGallery::Consumer < RhoGallery::Base
   
-  def create_new(data = @attributes, options = RhoGallery.credentials, resource = "consumers")
+  def create(data = @attributes, options = RhoGallery.credentials, resource = "consumers")
+    super(data, options, resource)
+  end
+
+  def save(data = @attributes, options = RhoGallery.credentials, resource = "consumers")
     super(data, options, resource)
   end
 
   def update(data = @attributes, options = RhoGallery.credentials, resource = "consumers/#{self.id}")
     if super(data, options, resource)
-      @attributes = RhoGallery::Consumer::find_by_id(self.id, options).get_attributes
+      @attributes = RhoGallery::Consumer::find(self.id, options).get_attributes
       self
     else
       false
@@ -17,8 +21,8 @@ class RhoGallery::Consumer < RhoGallery::Base
     super(options, resource)
   end
 
-  def self.find_by_id(id = "", options = RhoGallery.credentials)
-    consumer = RhoGallery::Base.find_by_id(id, options, "consumers")
+  def self.find(id = "", options = RhoGallery.credentials)
+    consumer = RhoGallery::Base.find(id, options, "consumers")
     RhoGallery::Consumer.new(RhoGallery.prepare_hash(consumer))
   end
 

data/lib/{rhogallery-api → rhogallery}/group.rb

@@ -1,6 +1,10 @@
 class RhoGallery::Group < RhoGallery::Base
 
-  def create_new(data = @attributes, options = RhoGallery.credentials, resource = "groups")
+  def create(data = @attributes, options = RhoGallery.credentials, resource = "groups")
+    super(data, options, resource)
+  end
+
+  def save(data = @attributes, options = RhoGallery.credentials, resource = "groups")
     super(data, options, resource)
   end
 
@@ -17,8 +21,8 @@ class RhoGallery::Group < RhoGallery::Base
     groups.collect!{|group| RhoGallery::Group.new(RhoGallery.prepare_hash(group))} unless groups.empty?
   end
 
-  def self.find_by_id(id, options = RhoGallery.credentials)
-    group = RhoGallery::Base.find_by_id(id, options, "groups")
+  def self.find(id, options = RhoGallery.credentials)
+    group = RhoGallery::Base.find(id, options, "groups")
     RhoGallery::Group.new(RhoGallery.prepare_hash(group))
   end
 

data/lib/rhogallery/version.rb

@@ -0,0 +1,3 @@
+module Rhogallery
+  VERSION = "0.1.0"
+end

data/lib/rhogallery.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "json"
+require "rest_client"
+require "rhogallery/version"
+require "rhogallery/rho_gallery"
+require "rhogallery/base"
+require "rhogallery/consumer"
+require "rhogallery/group"
+ENV['rhogallery_api_url'] = "https://app.rhohub.com/rhogallery/api/v1/:username/:resource.json"

data/rhogallery.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require 'rhogallery-api/version'
+require 'rhogallery/version'
 
 Gem::Specification.new do |s|
   s.name        = "rhogallery"

data/spec/consumer_spec.rb

@@ -14,7 +14,7 @@ describe RhoGallery::Consumer do
     end
     
     it "should make a GET request to get a consumer by ID" do
-      RhoGallery::Consumer.find_by_id("4e6146d5bdd0c8048c000004")
+      RhoGallery::Consumer.find("4e6146d5bdd0c8048c000004")
       WebMock.should have_requested(:get, RhoGallery.resource_url("testuser", "consumers/4e6146d5bdd0c8048c000004"))
     end
   end
@@ -22,17 +22,17 @@ describe RhoGallery::Consumer do
   context "Create, update and Delete actions" do
     it "should send a POST request to save a new consumer" do
       new_cons = RhoGallery::Consumer.new({:login => "testconsumer", :name => "this is a name"})
-      new_cons.create_new
+      new_cons.save
       WebMock.should have_requested(:post, RhoGallery.resource_url("testuser", "consumers"))
     end
     it "should send a PUT request to update a consumer" do
-      consumer = RhoGallery::Consumer.find_by_id("4e6146d5bdd0c8048c000004")
+      consumer = RhoGallery::Consumer.find("4e6146d5bdd0c8048c000004")
       consumer.login = "new_login_for_this_consumer"
       consumer.update
       WebMock.should have_requested(:put, RhoGallery.resource_url("testuser", "consumers/4e6146d5bdd0c8048c000004"))
     end
     it "should send a DELETE request to delete a consumer" do
-      consumer = RhoGallery::Consumer.find_by_id("4e6146d5bdd0c8048c000004")
+      consumer = RhoGallery::Consumer.find("4e6146d5bdd0c8048c000004")
       consumer.delete
       WebMock.should have_requested(:delete, RhoGallery.resource_url("testuser", "consumers/4e6146d5bdd0c8048c000004"))
     end
@@ -40,14 +40,14 @@ describe RhoGallery::Consumer do
       stub_request(:post, RhoGallery.resource_url("testuser", "consumers")).
         to_return({:status => 422, :body => "login can't be blank"})
       new_cons = RhoGallery::Consumer.new({:name => "this is a name"})
-      new_cons.create_new
+      new_cons.save
       WebMock.should have_requested(:post, RhoGallery.resource_url("testuser", "consumers"))
       new_cons.errors.should == "login can't be blank"
     end
     it "should respond with error when is trying to update a consumer with wrong attributes" do
       stub_request(:put, RhoGallery.resource_url("testuser", "consumers/4e6146d5bdd0c8048c000004")).
         to_return({:status => 422, :body => "login can't be blank"})
-      consumer = RhoGallery::Consumer.find_by_id("4e6146d5bdd0c8048c000004")
+      consumer = RhoGallery::Consumer.find("4e6146d5bdd0c8048c000004")
       consumer.login = ""
       consumer.update
       WebMock.should have_requested(:put, RhoGallery.resource_url("testuser", "consumers/4e6146d5bdd0c8048c000004"))
@@ -57,7 +57,7 @@ describe RhoGallery::Consumer do
   
   context "Get and set consumers values" do
     before(:each) do
-      @consumer = RhoGallery::Consumer.find_by_id("4e6146d5bdd0c8048c000004")
+      @consumer = RhoGallery::Consumer.find("4e6146d5bdd0c8048c000004")
     end
     
     it "should get the consumer values and set new values" do

data/spec/group_spec.rb

@@ -14,7 +14,7 @@ describe RhoGallery::Group do
     end
     
     it "should make a GET request when is finding a group by ID" do
-      RhoGallery::Group.find_by_id("4e6146d5bdd0c8048c000004")
+      RhoGallery::Group.find("4e6146d5bdd0c8048c000004")
       WebMock.should have_requested(:get, RhoGallery.resource_url("testuser", "groups/4e6146d5bdd0c8048c000004"))
     end
   end
@@ -22,11 +22,11 @@ describe RhoGallery::Group do
   context "Create and delete actions" do
     it "should send a POST request when is creating a new group" do
       new_group = RhoGallery::Group.new({:name => "group_name"})
-      new_group.create_new()
+      new_group.save
       WebMock.should have_requested(:post, RhoGallery.resource_url("testuser", "groups"))
     end
     it "should send a DELETE request when is deleting a group" do
-      group = RhoGallery::Group.find_by_id("4e6146d5bdd0c8048c000004")
+      group = RhoGallery::Group.find("4e6146d5bdd0c8048c000004")
       group.delete
       WebMock.should have_requested(:delete, RhoGallery.resource_url("testuser", "groups/4e6146d5bdd0c8048c000004"))
     end
@@ -34,7 +34,7 @@ describe RhoGallery::Group do
       stub_request(:post, RhoGallery.resource_url("testuser", "groups")).
         to_return({:status => 422, :body => "name can't be blank"})
       new_group = RhoGallery::Group.new
-      new_group.create_new
+      new_group.save
       WebMock.should have_requested(:post, RhoGallery.resource_url("testuser", "groups"))
       new_group.errors.should == "name can't be blank"
     end
@@ -42,7 +42,7 @@ describe RhoGallery::Group do
   
   context "Get groups values" do
     it "should get al the group values" do
-      group = RhoGallery::Group.find_by_id("4e6146d5bdd0c8048c000004")
+      group = RhoGallery::Group.find("4e6146d5bdd0c8048c000004")
       group.name.should == "koombea"
       group.id.should == "4e6146d5bdd0c8048c000004"
     end
@@ -50,7 +50,7 @@ describe RhoGallery::Group do
   
   context "Update method doesn't exist for groups" do
     it "should raise a NotMethod Exception when is trying to update a group" do
-      group = RhoGallery::Group.find_by_id("4e6146d5bdd0c8048c000004")
+      group = RhoGallery::Group.find("4e6146d5bdd0c8048c000004")
       lambda { group.update }.should raise_error
     end
   end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 $:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'rhogallery-api'
+require 'rhogallery'
 require 'rspec'
 require 'webmock/rspec'
 include WebMock::API

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rhogallery
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Rhomobile
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-22 00:00:00 Z
+date: 2011-09-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -65,12 +65,12 @@ files:
 - README.markdown
 - Rakefile
 - init.rb
-- lib/rhogallery-api.rb
-- lib/rhogallery-api/base.rb
-- lib/rhogallery-api/consumer.rb
-- lib/rhogallery-api/group.rb
-- lib/rhogallery-api/rho_gallery.rb
-- lib/rhogallery-api/version.rb
+- lib/rhogallery.rb
+- lib/rhogallery/base.rb
+- lib/rhogallery/consumer.rb
+- lib/rhogallery/group.rb
+- lib/rhogallery/rho_gallery.rb
+- lib/rhogallery/version.rb
 - rhogallery.gemspec
 - spec/consumer_spec.rb
 - spec/group_spec.rb

data/lib/rhogallery-api/version.rb

@@ -1,3 +0,0 @@
-module Rhogallery
-  VERSION = "0.0.1"
-end

data/lib/rhogallery-api.rb

@@ -1,9 +0,0 @@
-require "rubygems"
-require "json"
-require "rest_client"
-require "rhogallery-api/version"
-require "rhogallery-api/rho_gallery"
-require "rhogallery-api/base"
-require "rhogallery-api/consumer"
-require "rhogallery-api/group"
-ENV['rhogallery_api_url'] = "https://appstaging.rhohub.com/rhogallery/api/v1/:username/:resource.json"