vibe 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3a618d2547d2ba134182f8af9d83961e3bec85f
-  data.tar.gz: e183c7107daa1c0254b547029b59fcb6180a6465
+  metadata.gz: 572f86112bab6191738be93ce7f36014f12e764e
+  data.tar.gz: a273852fd99843b808095f012054822f4dfd134c
 SHA512:
-  metadata.gz: 292c62a9feff52f505a9703721c26d0e5d8ec988e98d150e2e3d576cb90ddc0ff3b5f680adf3052c75d142675c375b7c1d3d20f021b9946469e4d74ed5336985
-  data.tar.gz: 7cfa1dbd417c5dcd9510433ccf835703b5225635df969627055d9b58fbba67c79ac6db602897fd0e0901baa467b92d603d2ef8c214e6a16af1b920b578307018
+  metadata.gz: c7446c1be177bcaa1a8c8b7b7deb721bf44c0205c78e44966cb707846fd1de73e95cf9f9b9bbdd5df8cdb84c8d9e15a8ce570925cd8582a6c4ea71900e5fcc4c
+  data.tar.gz: 96293a87ce562ae4cd8e353d33c5cd2ccc99d58636cee83b243df843c0cd115bd0c43ae7003386ccc6a26c8d0af268c35563b01c6e4f6ce481add233a4c6e23b

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    vibe (0.0.1)
-      rest-client (~> 1.7.2)
+    vibe (0.0.2)
+      rest-client (~> 1.7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,7 +1,67 @@
 Vibe API
 ========
+[![Gem Version](https://badge.fury.io/rb/vibe.png)][gem]
+[![Dependency Status](https://gemnasium.com/amalfra/vibe.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/amalfra/vibe.png)][codeclimate]
+
+[gem]: http://badge.fury.io/rb/vibe
+[gemnasium]: https://gemnasium.com/amalfra/vibe
+[codeclimate]: https://codeclimate.com/github/amalfra/vibe
+
+[RDocs](http://rubydoc.info/github/amalfra/vibe/master/frames)
+
+A Ruby wrapper for the Vibe REST API. 
+
+> Get API key here : https://vibeapp.co/dev/
+
+## Installation
+
+Install the gem by running
+
+```ruby
+gem install vibe
+```
+
+or put it in your Gemfile and run `bundle install`
+
+```ruby
+gem "vibe"
+```
+
+## Usage
+
+Create a new instance
+
+```ruby
+vibe = Vibe.new
+```
+
+At this stage you can also supply the configuration parameter `:api_key` which is used throughout the API. These can be passed directly as hash options:
+
+```ruby
+vibe = Vibe.new api_key: 'api_key'
+```
+
+Alternatively, you can configure the Vibe settings by passing a block:
+
+```ruby
+vibe = Vibe.new do |config|
+  config.api_key   = 'api_key'
+end
+```
+
+## API
+
+The currently available api methods are :
+ * get_data(email) - Get Data from an Email
+ * stats           - Get Stats for API Key. If API key parameter is not
+                     passed then the one in config will be used 
+
+
+## Development
+
+Questions or problems? Please post them on the [issue tracker](https://github.com/amalfra/vibe/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `rake test`.
 
-A Ruby wrapper for the Vibe REST API.
 
 UNDER MIT LICENSE
 =================

data/lib/vibe/client.rb

@@ -24,8 +24,23 @@ module Vibe
 
     # Get Data from an Email
     def get_data(email)
+      if !email.is_a? String 
+        error = InvalidOptions.new(['Email(String)'], ['Email(String)'])
+        raise error
+      end
+
       get_request '/initial_data', :email => email
     end
 
+    # Get Stats for API Key
+    def stats(api_key = nil)
+      if api_key && (!api_key.is_a? String)
+        error = InvalidOptions.new(['API key(String)'], ['API key(String)'])
+        raise error
+      end
+
+      get_request '/api_stats', :api_key => api_key
+    end
+
   end # Client
 end

data/lib/vibe/error/invalid_options.rb

@@ -5,7 +5,7 @@ module Vibe
       def initialize(invalid, valid)
         super(
           generate_message(
-            :problem => "Invalid option #{invalid.keys.join(', ')} provided for this request.", 
+            :problem => "Invalid option #{invalid.join(', ')} provided for this request.", 
             :summary => "Vibe gem checks the request parameters passed to ensure that Vibe api is not hit unnecessairly and to fail fast.",
             :resolution => "Valid options are: #{valid.join(', ')}, make sure these are the ones you are using"
           )

data/lib/vibe/request.rb

@@ -23,7 +23,13 @@ module Vibe
 
       puts "EXECUTED: #{method} - #{path} with #{params}" if ENV['DEBUG']
 
-      params.merge!({:api_key => api_key, :user_agent => user_agent})
+      if params[:api_key]
+        new_api_key = params[:api_key]
+        params = params.tap { |hs| hs.delete(:api_key) }
+        params.merge!({:api_key => new_api_key, :user_agent => user_agent})
+      else
+        params.merge!({:api_key => api_key, :user_agent => user_agent})
+      end
 
       begin
         puts params if ENV['DEBUG']

data/lib/vibe/version.rb

@@ -1,3 +1,3 @@
 module Vibe
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vibe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Amal Francis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-18 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client