kreepr 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ecd04043c709326365a7868afb5b0fe33f83fff
-  data.tar.gz: eb4b410d1f74a51346cdb34c4c8d8dc7414aaaed
+  metadata.gz: 6f32ac3a9da64926d4637511ee31716061427b03
+  data.tar.gz: 3f06d58e00cb60f3e6dda69c35bd8b48dee8267a
 SHA512:
-  metadata.gz: 4b59bebc2d46f6440838b89f78dd257a10060099897ce874edd24d72194a9d771b3a85b64697ea27a43ea3443f27582fb8d98f220d334c5ad9b0f35be3d869d8
-  data.tar.gz: b160df33cc65e1c54bfcebcf04f26b280e5209a9574b0a5d81bee591902bed954172d9a4cb1ae03499b09731d549f55e825007a1585cb6e501fc513273a8ff3e
+  metadata.gz: c15a4140afd1f1afa4574b040578cb21e070176224cb6cdbe12fd76a2fca4ad8a5e4fb2b6a72215118ecc5cb4b903b37010d09d15191bf74024dd1cc7a7d6915
+  data.tar.gz: 911daa55d7b23091c9ce8f1ed8f3537f6cb99d633da21ddfe3f3002972fa55cd1e85f0b3f60ac68e1b9a3054be6623eba1faddf27be3b2f3979d5571178173a0

data/README.md

@@ -28,12 +28,10 @@ Let's get Kreeping!
 
 First, you'll need to [create a Kreepr account](http://kreepr.com/), then navigate to your [account page](http://kreepr.com/account) to retrieve your API key.
 
-Once you have your key, configure the gem by setting your API key as such (in a Rails app, this could be put in config/initializers/kreepr.rb):
+Once you have your key, configure the gem by setting your API key as such:
 
 ```ruby
-Kreepr.configure do |config|
-  config.api_key = YOUR_API_KEY
-end
+client = Kreepr::Client.new(:api_key => <your api key>)
 ```
 
 That's it! You're ready to talk to Feed Engine.
@@ -43,19 +41,19 @@ That's it! You're ready to talk to Feed Engine.
 Retrieve feed items for a specific trip (trip must be public, or you must have permissions to view it):
 
 ```ruby
-Kreepr.feed({:username => <username>, :trip_id => <trip id>})
+client.feed(:username => <username>, :trip_id => <trip id>)
 ```
 
 Retrieve only notes posted from Kreepr:
 
 ```ruby
-Kreepr.feed({:username => <username>, :trip_id => <trip id>, :only => :text})
+client.feed(:username => <username>, :trip_id => <trip id>, :only => :text)
 ```
 
-Publish a text feed item given the appropriate arguments, via POST
+Publish a text feed item given the appropriate arguments, via POST. (Next version)
 
 ```ruby
-Kreepr.post_note({:username => <username>, :trip_id => <trip id>, :text => <text>})
+client.post_note(:username => <username>, :trip_id => <trip id>, :text => <text>)
 ```
 
 ### Contributing

data/lib/kreepr.rb

@@ -3,11 +3,15 @@ require "faraday"
 require "openssl"
 
 require "kreepr/version"
-require "kreepr/configurable"
 
 module Kreepr
-  class << self
-    include Configurable
+  class Client
+    attr_reader :api_key
+
+    def initialize(params)
+      @api_key = params[:api_key]
+      validate_api_key!(@api_key)
+    end
 
     def feed(params, timeout = 10)
       validate_params!(params)
@@ -19,7 +23,15 @@ module Kreepr
       JSON.parse(response.body)
     end
 
-    private
+  private
+
+    def validate_api_key!(api_key)
+      if !api_key.nil?
+        unless api_key.is_a?(String) || api_key.is_a?(Symbol)
+          raise ArgumentError, "Invalid api_key specified: #{api_key} must be a string or symbol."
+        end
+      end
+    end
 
     def validate_params!(params)
       unless params[:trip_id].is_a?(String) && params[:username].is_a?(String)

data/lib/kreepr/version.rb

@@ -1,3 +1,3 @@
 module Kreepr
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/kreepr_spec.rb

@@ -1,23 +1,19 @@
 require 'spec_helper'
 
 describe Kreepr do
+  subject do
+    Kreepr::Client.new(:api_key => '123')
+  end
+
   context 'with an api_key of valid type' do
     it 'should be configurable' do
-      Kreepr.configure do |config|
-        config.api_key = "abc_123"
-      end
-
-      expect(Kreepr.api_key).to eq 'abc_123'
+      expect(subject.api_key).to eq '123'
     end
   end
 
   context 'with an api_key of invalid type' do
     it 'should raise an argument error' do
-      expect {
-        Kreepr.configure do |config|
-          config.api_key = {"abc_123" => :hello}
-        end
-        }.to raise_error ArgumentError
+      expect { Kreepr::Client.new(12345) }.to raise_error TypeError
     end
   end
 
@@ -27,55 +23,27 @@ describe Kreepr do
     context 'with invalid input' do
       it 'should raise an argument error without a username' do
         params[:username] = nil
-        expect { Kreepr.feed(params) }.to raise_error ArgumentError
+        expect { subject.feed(params) }.to raise_error ArgumentError
       end
 
       it 'should raise an argument error with an invalid username type' do
         params[:username] = 1234
-        expect { Kreepr.feed(params) }.to raise_error ArgumentError
+        expect { subject.feed(params) }.to raise_error ArgumentError
       end
 
       it 'should raise an argument error without a trip_id' do
         params[:trip_id] = nil
-        expect { Kreepr.feed(params) }.to raise_error ArgumentError
+        expect { subject.feed(params) }.to raise_error ArgumentError
       end
 
       it 'should raise an argument error with an invalid trip_id type' do
         params[:trip_id] = 1234
-        expect { Kreepr.feed(params) }.to raise_error ArgumentError
+        expect { subject.feed(params) }.to raise_error ArgumentError
       end
 
       it 'does not raise an error without a :text_only flag' do
         params.delete(:text_only)
-        expect { Kreepr.feed(params) }.to_not raise_error ArgumentError
-      end
-    end
-
-    context 'with valid input' do
-      context 'but invalid or missing api_key' do
-        let(:bad_auth_response) do
-          JSON.parse('{ "errors": [ { "message":"Bad Authentication data","code":215 } ] }')
-        end
-
-        it 'receives an bad authentication error' do
-          expect(Kreepr.feed(params)).to eq bad_auth_response
-        end
-      end
-
-      context 'with a valid api_key' do
-        let(:params) { {:username => 'ebdrummond', :trip_id => '1', :text_only => true} }
-
-        context 'to a public trip' do
-          it 'returns the feed'
-        end
-
-        context 'to a private trip I have access to' do
-          it 'returns the feed'
-        end
-
-        context 'to a private trip I do not have access to' do
-          it 'raises an error'
-        end
+        expect { subject.feed(params) }.to_not raise_error ArgumentError
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kreepr
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Raphael Weiner, Erin Drummond, Kyle Suss, Phil Battos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,6 @@ files:
 - Rakefile
 - kreepr.gemspec
 - lib/kreepr.rb
-- lib/kreepr/configurable.rb
 - lib/kreepr/version.rb
 - spec/kreepr_spec.rb
 - spec/spec_helper.rb

data/lib/kreepr/configurable.rb

@@ -1,20 +0,0 @@
-module Kreepr
-  module Configurable
-    attr_accessor :api_key
-
-    def configure
-      yield self
-      validate_key_type!
-    end
-
-    private
-
-    def validate_key_type!
-      if !api_key.nil?
-        unless api_key.is_a?(String) || api_key.is_a?(Symbol)
-          raise ArgumentError, "Invalid api_key specified: #{api_key} must be a string or symbol."
-        end
-      end
-    end
-  end
-end