horntell 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1e9a25bd56f75eaff3ecb4006c9f2a19b68b8a1
-  data.tar.gz: a7c449eb80509f8f50fd9812f7ef6d964bff6d32
+  metadata.gz: 3e59ea212c8612cec68559998a305e0375c8c848
+  data.tar.gz: b0bb08528724e12dfca9cba50fb47f7b17da7f44
 SHA512:
-  metadata.gz: 63f82bca3f8311fee533c4bc7b71d79785023e2bd459b427736d748f109fa78b0b1e7bdb29cef834ba66eb1b6dccc3585413da80a1100480676d14dfb6b92064
-  data.tar.gz: 8486ddbb167337758b49e4002185374c75e9ef2f64d840fd0599b550de51473bcc24626de804d5d410c70579fbe6626198af2e581aeca05fc395ac8876f8d463
+  metadata.gz: d37ad03a32b0834f2e2b656aad8ebc240f87028b900f03e0d5ef577050e1687bd035474314c9e1d7a5b058a1bc6d6478d6207380ac1f4151e50b5e24313717e8
+  data.tar.gz: f3e95161101a37b77fba2c83f7b33fa51b81d77a12c36128ec3f045ffc66a4d7bc47b34f60e97559cba24bb321ab31535ee8083c86facf752ef0d7fbb2ef227a

data/README.md

@@ -1,31 +1,56 @@
-# Horntell::Ruby
+Horntell SDK for Ruby
+====================
 
-TODO: Write a gem description
+This SDK allows you to easily integrate Horntell in your Ruby applications.
+
+## Requirements
+**Ruby 1.9.2 and later.**
+
+**Gems: rest-client, json**
 
 ## Installation
+You don't need this source code unless you want to modify the gem. If you just want to use the Horntell Ruby SDK, you should run:
+
+```
+gem install horntell
+```
+
+If you want to build the gem from source, run this:
+
+```
+gem build horntell.gemspec
+```
 
-Add this line to your application's Gemfile:
+## Bundler
+If you are installing via bundler, you should be sure to use the https rubygems source in your Gemfile, as any gems fetched over http could potentially be compromised in transit and alter the code of gems fetched securely over https:
 
 ```ruby
+source 'https://rubygems.org'
+
 gem 'horntell'
 ```
 
 And then execute:
 
-    $ bundle
+```
+bundle install
+```
 
-Or install it yourself as:
+## Getting Started
 
-    $ gem install horntell
+You need to `init`ialize the SDK with the app's key and secret, which you can find in your account at [http://app.horntell.com](http://app.horntell.com). Sample usage looks like this.
 
-## Usage
+```ruby
+Horntell::init('YOUR_APP_KEY', 'YOUR_APP_SECRET');
+Horntell::Profile.create({
+	:uid => "1337",
+	:first_name => "John",
+	:last_name => "Doe",
+	:signedup_at => 1383350400
+})
 
-TODO: Write usage instructions here
+```
 
-## Contributing
+## Documentation
 
-1. Fork it ( https://github.com/[my-github-username]/horntell-ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Please see [http://docs.horntell.com/api](http://docs.horntell.com/api/?ruby) for up-to-date documentation.

data/lib/horntell/errors/authentication_error.rb

@@ -1,4 +1,6 @@
 module Horntell
-	class AuthenticationError < Error
+	module Errors
+		class AuthenticationError < Error
+		end
 	end
 end

data/lib/horntell/errors/error.rb

@@ -1,13 +1,15 @@
 module Horntell
-	class Error < StandardError
-		attr_reader :message
-		attr_reader :code
-		attr_reader :type
+	module Errors
+		class Error < StandardError
+			attr_reader :message
+			attr_reader :code
+			attr_reader :type
 
-		def initialize(message = nil, code = nil, type = nil)
-			@message = message
-			@code = code
-			@type = type
+			def initialize(message = nil, code = nil, type = nil)
+				@message = message
+				@code = code
+				@type = type
+			end
 		end
 	end
 end

data/lib/horntell/errors/forbidden_error.rb

@@ -1,4 +1,6 @@
 module Horntell
-	class ForbiddenError < InvalidRequestError
+	module Errors
+		class ForbiddenError < InvalidRequestError
+		end
 	end
 end

data/lib/horntell/errors/invalid_request_error.rb

@@ -1,4 +1,6 @@
 module Horntell
-	class InvalidRequestError < Error
+	module Errors
+		class InvalidRequestError < Error
+		end
 	end
 end

data/lib/horntell/errors/network_error.rb

@@ -1,12 +1,14 @@
 module Horntell
-	class NetworkError < Error
-		attr_accessor :message
-		attr_accessor :type
+	module Errors
+		class NetworkError < Error
+			attr_accessor :message
+			attr_accessor :type
 
-		def initialize(message = nil, code = nil, type = nil)
-			super(message, code, type)
-			@message = "Could not connect to Horntell. Please check your network connection and try again. If the problem persists, please get in touch with us at hello@horntell.com."
-			@type = 'network_error'
+			def initialize(message = nil, code = nil, type = nil)
+				super(message, code, type)
+				@message = "Could not connect to Horntell. Please check your network connection and try again. If the problem persists, please get in touch with us at hello@horntell.com."
+				@type = 'network_error'
+			end
 		end
 	end
 end

data/lib/horntell/errors/not_found_error.rb

@@ -1,4 +1,6 @@
 module Horntell
-	class NotFoundError < InvalidRequestError
+	module Errors
+		class NotFoundError < InvalidRequestError
+		end
 	end
 end

data/lib/horntell/errors/service_error.rb

@@ -1,4 +1,6 @@
 module Horntell
-	class ServiceError < Error
+	module Errors
+		class ServiceError < Error
+		end
 	end
 end

data/lib/horntell/http/client.rb

@@ -21,10 +21,10 @@ module Horntell
 					if code = e.http_code and body = e.http_body
 						return handle_api_error(code, body)
 					else
-						raise Horntell::NetworkError.new
+						raise Horntell::Errors::NetworkError.new
 					end
 				rescue Exception => e
-					raise Horntell::NetworkError.new
+					raise Horntell::Errors::NetworkError.new
 				end
 			end
 
@@ -49,27 +49,27 @@ module Horntell
 			end
 
 			def authentication_error(error, code)
-				AuthenticationError.new(error["message"], code, error["type"])
+				Horntell::Errors::AuthenticationError.new(error["message"], code, error["type"])
 			end
 
 			def forbidden_error(error, code)
-				ForbiddenError.new(error["message"], code, error["type"])
+				Horntell::Errors::ForbiddenError.new(error["message"], code, error["type"])
 			end
 
 			def horntell_error(error, code)
-				HorntellError.new(error["message"], code, error["type"])
+				Horntell::Errors::HorntellError.new(error["message"], code, error["type"])
 			end
 
 			def invalid_request_error(error, code)
-				InvalidRequestError.new(error["message"], code, error["type"])
+				Horntell::Errors::InvalidRequestError.new(error["message"], code, error["type"])
 			end
 
 			def not_found_error(error, code)
-				NotFoundError.new(error["message"], code, error["type"])
+				Horntell::Errors::NotFoundError.new(error["message"], code, error["type"])
 			end
 
 			def service_error(error, code)
-				ServiceError.new(error["message"], code, error["type"])
+				Horntell::Errors::ServiceError.new(error["message"], code, error["type"])
 			end
 		end
 	end

data/lib/horntell/version.rb

@@ -1,3 +1,3 @@
 module Horntell
-	VERSION = "0.1.0"
+	VERSION = "0.2.0"
 end

data/lib/horntell.rb

@@ -45,5 +45,9 @@ module Horntell
 		def get_secret()
 			return @secret
 		end
+
+		def set_version(version=nil)
+			@version = version
+		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: horntell
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mohit Mamoria