ruby-sendhub 0.0.4 → 0.0.5

data/README.md

@@ -1,7 +1,6 @@
 # ruby-sendhub
 
 ruby-sendhub is a simple API wrapper for interacting with [SendHub API](http://www.sendhub.com/developer)
-It's my first ever gem, so I'm crying right now as you read this.
 
 ##Installation
 
@@ -11,7 +10,7 @@ It's my first ever gem, so I'm crying right now as you read this.
 
 A SendHub account. Get your API key [here](https://www.sendhub.com/settings)
 
-##Usage
+##Getting started
 
 Create a new instance of the API wrapper:
 
@@ -25,15 +24,90 @@ SendHub API uses RESTful services. Every methods begin with post, put, update, o
 
 		sh.post_contacts({:name => "SoonKhen OwYong", :number => 4040404040, :address => "1 Infinite Loop", :city => "Cupertino", :zip => "95014"})
 
-Every put or delete requests must have :id in it
+Every put or delete requests must have an :id hash key
 
 		sh.delete_contacts({:id => [11]})
 
-##Special Thanks
+##Messages
 
-* My mom and dad, seriously, first gem you know
-* [Amro Mousa](https://github.com/amro) for his source code on Gibbon which inspired this code
+Sending a Message
 
-##License
+		sh.post_messages({:contacts => [1111], :text => "Testing"})
 
-No time for this, just do whatever you want
+Scheduling a Message
+
+		sh.post_messages({:contacts => [1111], :text => "Testing", :scheduled_at => "2011-02-17T20:29:40-0800"})
+
+Get Message Status
+
+		sh.get_messages({:id => 11})
+
+Mark Message as Read
+
+		sh.put_messages({:id => 11, :unread => "false"})
+
+##Contacts
+
+Adding a Contact
+
+		sh.post_contacts({:name => "John Doe", :number => "6501234567"})
+
+Adding a Contact with Additional Data
+
+		sh.post_contacts({:name => "John Doe", :number => "6501234567", :groups => [11,12], :address => "1 Infinite Loop", :city => "Cupertino", :zip => "95014"})
+
+Collecting Contacts Data
+
+		sh.get_contacts
+
+Editing a Contact
+
+		sh.put_contacts({:id => 22413, :name => "Jesse Doe", :number => 6501234567})
+
+Deleting a Contact
+
+		sh.delete_contacts({:id => 22413})
+
+##Groups
+
+Adding a Group
+
+		sh.post_groups({:name => "Regulars", :slug => "regulars", :text_to_subscribe => true})
+
+Collect Groups List
+
+		sh.get_groups
+
+Collect a Single Group's Contacts
+
+		sh.get_groups_contacts({:id => 1220})
+		
+Adding and Removing Contacts
+		
+		sh.post_groups_contacts({:id => 1220, :add => [22081], :remove => [22411, 22412]})
+
+Editing a Group
+
+		sh.put_groups({:id => 1220, :name => "Best Customers", :slug => "regulars", :text_to_subscribe => true})
+
+Deleting a Group
+
+		sh.delete_groups({:id => 1220})
+		
+##Inbox
+
+Collecting the Inbox
+
+		sh.get_inbox
+
+##Threads
+
+Viewing Threads
+
+		sh.get_threads({:id => 12555})
+
+##Profile
+
+Collecting the Profile
+
+		sh.get_profile

data/lib/ruby-sendhub.rb

@@ -17,16 +17,39 @@ class SendHub
 	def method_missing(method, hsh = {})
 		meth = method.to_s.split("_")
 		if meth.first == "put" || meth.first == "delete"
+			if meth.last == "messages"
+				api_url = base_url + meth.last + "/" + hsh[:id].to_s + credentials
+				hsh.delete(:id)
+			else
+				api_url = base_url + meth.last + "/" + hsh[:id].to_s + credentials
+			end
+		elsif meth.first == "get" && (meth.last == "threads" || meth.last == "messages" || !hsh[:id].nil?)
 			api_url = base_url + meth.last + "/" + hsh[:id].to_s + credentials
 		else
 			api_url = base_url + meth.last + credentials
 		end
-		ret = self.class.send(meth.first, api_url, :body => hsh.to_json).parsed_response
+		ret = send_request(meth.first, api_url, :body => hsh.to_json)
 		ret.nil? && meth.first == "delete" ? "Aaaand it's gone" : ret
 	end
 
+	def get_groups_contacts(hsh = {})
+		send_request("get", group_contacts_url(hsh), :body => hsh.to_json)
+	end
+
+	def post_groups_contacts(hsh = {})
+		send_request("post", group_contacts_url(hsh), :body => hsh.to_json)
+	end
+
 	private
 
+		def group_contacts_url(hsh)
+			base_url + "groups/" + hsh[:id].to_s + "/contacts" + credentials
+		end
+
+		def send_request(request_type, url, json)
+			self.class.send(request_type, url, json).parsed_response
+		end
+
 		def base_url
 			"https://api.sendhub.com/v1/"
 		end

data/lib/ruby-sendhub/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module Sendhub
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-sendhub
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-08 00:00:00.000000000 Z
+date: 2012-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &19992840 !ruby/object:Gem::Requirement
+  requirement: &21865320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19992840
+  version_requirements: *21865320
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &19989000 !ruby/object:Gem::Requirement
+  requirement: &21881660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19989000
+  version_requirements: *21881660
 description: My first gem and no tests yet. Ruby wrapper for SendHub API
 email:
 - dude@owyong.sk