redflex-hydrogen-ruby 0.1.1 → 0.9.0

data/README.md

@@ -1,12 +1,14 @@
 Hydrogen
 ========
 
-This is a Hydrogen API Ruby client library.
+This is a Hydrogen API Ruby client library. As the Hydrogen API is updated
+there will be a simultaneous update of this library.
 
 
 ## Requirements ##############################################################
 
 * HTTParty
+* Mash
 
 
 ## Install ###################################################################
@@ -37,4 +39,42 @@ and cloned with:
 
 ## Usage #####################################################################
 
-***TODO:** Usage docs*
+Hydrogen-ruby gives you object model access to the Hydrogen API. Once you have
+created a `client` object, you can traverse it to find topics and comments.
+
+
+### Initialize a Client Object ###############################################
+
+The first step is to create a `Hydrogen::Base` object to represent your
+client.
+
+	require 'hydrogen'
+	client = Hydrogen::Base.new('redflex')
+	
+In the above example, the Hydrogen account is `redflex` (this is the same as
+*account*.hydrogenapp.com, **not** your user name).
+
+
+### Getting a list of topics #################################################
+
+From the `Base` object you can get a list of topics as an array. This defaults
+to the last 15 topics to be created, as specified in the Hydrogen API.
+
+	client.topics.each { |topic| puts topic.inspect }
+
+You can also pass any Hydrogen API parameters to this method, for example:
+
+	client.topics({ :page => 1 }).each { |topic| puts topic.inspect }
+	
+You can also get a single topic. *Note: this method is `topic` and **not**
+`topics`*.
+
+	client.topic( topic_id ).inspect
+
+
+### Getting a list of comments ###############################################
+
+You can also get a list of comments from the `Base` object. You will, of
+course, need to know the `topic_id`.
+
+	client.comments( topic_id ).each { |comment| puts comment.inspect }

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 1
-:patch: 1
+:minor: 9
+:patch: 0

data/lib/hydrogen/base.rb

@@ -2,9 +2,6 @@ module Hydrogen
 	class Base
 		
 		
-		#attr_reader :client
-		
-		
 		def initialize(account, username='', password='', options={})
 			@options = options
 			base_uri = "http#{'s' if options[:ssl]}://#{account}.hydrogenapp.com"
@@ -14,31 +11,55 @@ module Hydrogen
 		
 		# Options: since_id, max_id, count, page, since
 		def topics(query={})
-			response = perform_get('/topics.json', :query => query)
+			response = perform_get("/topics.json", query)
 			response['topics']
 		end
 		
 		
+		# Options: 
 		def topic(id)
 			response = perform_get("/topics/#{id}.json")
 		end
 		
 		
-		def comments(topic_id)
-			response = perform_get("/topics/#{topic_id}/comments.json")
+		# Options:
+		def create_topic(query={})
+			response = perform_post("/topics/create.json", query)
+		end
+		
+		
+		# Options:
+		def delete_topic(id)
+			response = perform_get("/topics/#{id}/delete.json")
+		end
+		
+		
+		# Options: 
+		def comments(topic_id, query={})
+			response = perform_get("/topics/#{topic_id}/comments.json", query)
 			response['comments']
 		end
 		
 		
+		# Options: 
+		def comment(topic_id, comment_id)
+			response = perform_get("/topics/#{topic_id}/comments/#{comment_id}.json")
+		end
+		
+		
+		# Options: comment*, reply_to
+		def create_comment(topic_id, query={})
+			response = perform_post("/topics/#{topic_id}/comments/create.json", query)
+		end
 		
 		
 		private
 			def perform_get(path, options={})
-				@request.perform_get("#{path}", options)
+				@request.perform_get(path, options)
 			end
 			
 			def perform_post(path, options={})
-				Request.perform_post(path, options)
+				@request.perform_post(path, options)
 			end
 			
 	end

data/lib/hydrogen/request.rb

@@ -2,13 +2,23 @@ module Hydrogen
 	class Request
 		
 		
+		include HTTParty
+		
+		
 		def initialize(options={})
 			@options = {:mash => true}.merge(options)
+			@auth = {:username => @options[:username], :password => @options[:password]} if @options[:username]
 		end
 		
 		
 		def perform_get(path, query={})
-			response = HTTParty.get("#{@options[:base_uri]}#{path}", :query => query)
+			response = self.class.get("#{@options[:base_uri]}#{path}", { :query => query, :basic_auth => @auth })
+			perform(response)
+		end
+		
+		
+		def perform_post(path, query={})
+			response = self.class.post("#{@options[:base_uri]}#{path}", { :query => query, :basic_auth => @auth })
 			perform(response)
 		end
 		

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: redflex-hydrogen-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.9.0
 platform: ruby
 authors: 
 - Matt Kirman