gnip-rule 0.1.1 → 0.2

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 1.8.7
+script: rspec spec

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+When submitting pull requests, please do the following to make it easier to incorporate your changes:
+
+* Include unit and/or functional specs that validate changes you're making.
+* Rebase your changes onto the HEAD of my fork if you can do so cleanly.
+* If submitting additional functionality, provide an example of how to use it.
+* Please keep code style consistent with surrounding code.
+
+## Testing
+You can run all tests by simply running `bundle exec rspec spec` from your favorite shell.

data/README.md

@@ -1,35 +1,37 @@
-# gnip-rule
-Ruby library for working with the Gnip Rules API
+# gnip-rule [![Build Status](https://secure.travis-ci.org/eriwen/gnip-rule.png)](http://travis-ci.org/eriwen/gnip-rule)
+This gem simplifies the effort to add/delete/list rules using the [Gnip Rules API](http://support.gnip.com/customer/portal/articles/477713-rules-methods-documentation). It handles HTTP request/response and helps your rules conform to Gnip's restrictions.
 
 ## Installation
-Add the following to your `Gemfile`:
+`gem install gnip-rule` or add the following to your `Gemfile`:
 
 ```ruby
-gem 'gnip-rule', '~> 0.1.1'
+gem 'gnip-rule', '~> 0.2'
 ```
 
-## Example
+## Usage
 
 ```ruby
 require 'gnip-rule'
 
-ruler = GnipRule::Client.new(GNIP_API_URL, GNIP_USERNAME, GNIP_PASSWORD)
+rules = GnipRule::Client.new(API_URL, USERNAME, PASSWORD)
 
 # Add as a String, Rule, or Array of either
-ruler.add('foo')
-ruler.add('bar', 'tag')
-ruler.add(['foo', 'bar', 'baz'], 'tag')
-ruler.add(GnipRule::Rule.new('value', 'tag'))
-ruler.add([GnipRule::Rule.new('value', 'tag'), ruler.add(GnipRule::Rule.new('othervalue', 'othertag'))])
+rules.add('foo')
+rules.add('bar', 'tag')
+rules.add(['foo', 'bar', 'baz'], 'tag')
+rules.add(GnipRule::Rule.new('value', 'tag'))
+rules.add([GnipRule::Rule.new('foo', 'bar'), GnipRule::Rule.new('baz', 'tag2')])
 
 # Same with delete
-ruler.delete('baz', 'tag')
-ruler.delete(['foo', 'bar'])
-ruler.delete(GnipRule::Rule.new('value', 'tag'))
+rules.delete('baz', 'tag')
+rules.delete(['foo', 'bar'])
+rules.delete(GnipRule::Rule.new('value', 'tag'))
 
-# Get all ruler as Rule objects
-ruler.list()
+# Get all rules
+rules.list()
 ```
 
 ## License
-MIT License: http://www.opensource.org/licenses/mit-license.php
+Licenced under the [MIT License](http://www.opensource.org/licenses/mit-license.php)
+
+I provide this software free of charge. If you find it helpful, please endorse me on coderwall: [![endorse](http://api.coderwall.com/eriwen/endorsecount.png)](http://coderwall.com/eriwen)

data/lib/gnip-rule/client.rb

@@ -49,16 +49,18 @@ module GnipRule
 
     protected
     def post(url, data)
+      err = nil
       Curl::Easy.http_post(url, data) do |curl|
         curl.http_auth_types = :basic
         curl.username = @username
         curl.password = @password
         curl.on_complete do |res|
           if res.response_code >= 400
-            raise "Got #{res.response_code}; body: #{res.body_str}"
+            err = "Got #{res.response_code}; body: #{res.body_str}"
           end
         end
       end
+      raise err if err
     end
   end
 end

data/lib/gnip-rule/rule.rb

@@ -10,7 +10,6 @@ module GnipRule
     end
 
     def valid?
-      # See http://docs.gnip.com/w/page/35663947/Power%20Track
       if contains_stop_word?(@value) || too_long?(@value) || contains_negated_or?(@value) || too_many_positive_terms?(@value) || contains_empty_source?(@value)
         return false
       end

data/lib/gnip-rule/version.rb

@@ -1,3 +1,3 @@
 module GnipRule
-  VERSION = '0.1.1'
+  VERSION = '0.2'
 end

data/spec/gnip-rule/client_spec.rb

@@ -22,8 +22,6 @@ describe GnipRule::Client do
       Curl::Easy.should_receive(:http_post)
       subject.add('value', 'tag')
     end
-
-    xit 'should raise an error if we got a 4xx or 5xx HTTP status'
   end
 
   describe '#delete' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gnip-rule
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -82,6 +82,7 @@ files:
 - .pryrc
 - .rvmrc
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md