gnip-rule 0.3 → 0.3.1

data/README.md

@@ -5,7 +5,7 @@ This gem simplifies the effort to add/delete/list rules using the [Gnip Rules AP
 `gem install gnip-rule` or add the following to your `Gemfile`:
 
 ```ruby
-gem 'gnip-rule', '~> 0.2'
+gem 'gnip-rule', '~> 0.3.1'
 ```
 
 ## Usage
@@ -28,7 +28,10 @@ rules.delete(['foo', 'bar'])
 rules.delete(GnipRule::Rule.new('value', 'tag'))
 
 # Get all rules
-rules.list()
+rules_list = rules.list()
+rules_list.each { |rule| rule.valid? }
+jsonified = rules_list.map { |rule| rule.as_json `}
+rules_tagged_foo = rules_list.select { |rule| rule.tag == 'foo' }
 ```
 
 ## License

data/Rakefile

@@ -1 +1,10 @@
-require 'bundler/gem_tasks'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => [:spec]

data/gnip-rule.gemspec

@@ -41,5 +41,4 @@ Gem::Specification.new do |s|
   s.add_dependency 'rest-client', '~> 1.6.7'
   s.add_dependency 'json', '~> 1.7.0'
   s.add_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
-  s.add_dependency 'openssl' if RUBY_PLATFORM == 'ruby'
 end

data/lib/gnip-rule/client.rb

@@ -4,7 +4,6 @@ require 'gnip-rule/rule'
 
 module GnipRule
   class Client
-
     attr_reader :url, :username, :password
 
     def initialize(url, username, password)
@@ -13,12 +12,12 @@ module GnipRule
       @password = password
     end
 
-    def add(value, tag=nil)
-      post(@url, jsonify_rules(value, tag))
+    def add(input, tag=nil)
+      post(@url, gen_json_payload(input, tag))
     end
 
-    def delete(value, tag=nil)
-      post("#@url?_method=delete", jsonify_rules(value, tag))
+    def delete(input, tag=nil)
+      post("#@url?_method=delete", gen_json_payload(input, tag))
     end
 
     def list()
@@ -28,16 +27,12 @@ module GnipRule
       JSON.parse(response.to_s)['rules'].collect { |o| Rule.new(o['value'], o['tag']) }
     end
 
-    def jsonify_rules(values, tag=nil)
-      rules = nil
-      if values.instance_of?(Array)
-        rules = values.collect { |o| o.instance_of?(Rule) ? o : Rule.new(o, tag) }
-      elsif values.instance_of?(Rule)
-        rules = [values]
-      else
-        rules = [Rule.new(values, tag)]
-      end
-      {:rules => rules.collect(&:as_hash)}.to_json
+    def gen_json_payload(input, tag=nil)
+      input = [input] unless input.respond_to? :collect
+      {:rules => input.collect { |i|
+        raise 'Input must be convertable to GnipRule::Rule' unless i.respond_to? :to_rule
+        i.to_rule(tag).to_hash
+      }}.to_json
     end
 
     protected

data/lib/gnip-rule/rule.rb

@@ -1,5 +1,11 @@
 require 'json'
 
+class String
+  def to_rule(tag=nil)
+    GnipRule::Rule.new(self, tag)
+  end
+end
+
 module GnipRule
   class Rule
     attr_accessor :value, :tag
@@ -10,46 +16,53 @@ module GnipRule
     end
 
     def valid?
-      if contains_stop_word?(@value) || too_long?(@value) || contains_negated_or?(@value) || too_many_positive_terms?(@value) || contains_empty_source?(@value)
-        return false
-      end
-      true
+      return false if too_long?
+      return false if too_many_positive_terms?
+      return false if contains_stop_word?
+      return false if contains_empty_source?
+      return false if contains_negated_or?
+      return true
+    end
+
+    # NOTE: Unused variable for consistency with other to_rule impls
+    def to_rule(_=nil)
+      self
     end
 
-    def as_json
-      as_hash.to_json
+    def to_json
+      to_hash.to_json
     end
 
-    def as_hash
+    def to_hash
       obj = {:value => @value}
       obj[:tag] = @tag unless @tag.nil?
       obj
     end
 
     def to_s
-      as_json
+      to_json
     end
 
     protected
-    def contains_stop_word?(value)
+    def contains_stop_word?
       stop_words = %W(a an and at but by com from http https if in is it its me my or rt the this to too via we www you)
-      (stop_words & value.gsub(/\"[^\"]*\"/, '').split(/\s/)).size > 0
+      (stop_words & @value.gsub(/\"[^\"]*\"/, '').split(/\s/)).size > 0
     end
 
-    def too_long?(value)
-      value.size > 1024
+    def too_long?
+      @value.size > 1024
     end
 
-    def contains_negated_or?(value)
-      !value[/\-\w+ OR/].nil?
+    def contains_negated_or?
+      !@value[/\-\w+ OR/].nil?
     end
 
-    def too_many_positive_terms?(value)
-      value.scan(/\b\w+|\"[\-\s\w]+\"\b/).size > 10
+    def too_many_positive_terms?
+      @value.scan(/\b\w+|\"[\-\s\w]+\"\b/).size > 10
     end
 
-    def contains_empty_source?(value)
-      !value[/source\:\s/].nil?
+    def contains_empty_source?
+      !@value[/source\:\s/].nil?
     end
   end
 end

data/lib/gnip-rule/version.rb

@@ -1,3 +1,3 @@
 module GnipRule
-  VERSION = '0.3'
+  VERSION = '0.3.1'
 end

data/spec/gnip-rule/client_spec.rb

@@ -3,79 +3,88 @@ require 'spec-helper'
 require 'gnip-rule/client'
 
 describe GnipRule::Client do
+  let(:xml_base_url) { 'https://api.gnip.com:443/accounts/foo/publishers/twitter/streams/track/prod/rules.xml' }
   let(:base_url) { 'https://api.gnip.com:443/accounts/foo/publishers/twitter/streams/track/prod/rules.json' }
   let(:base_url_with_auth) { 'https://username:password@api.gnip.com:443/accounts/foo/publishers/twitter/streams/track/prod/rules.json' }
-  subject { GnipRule::Client.new(base_url, 'username', 'password') }
 
-  describe '#initialize' do
+  describe '.new' do
     it 'should convert XML URLs to JSON' do
-      subject.url.should == base_url
+      GnipRule::Client.new(xml_base_url, 'username', 'password').url.should == base_url
     end
-  end
 
-  describe '#add' do
-    it 'should POST rule to the given URL with given credentials' do
-      stub_request(:post, base_url_with_auth).
-          with(:body => '{"rules":[{"value":"value","tag":"tag"}]}').
-          to_return(:status => 200, :body => '', :headers => {})
-      subject.add('value', 'tag')
+    it 'should not munch JSON URLs' do
+      GnipRule::Client.new(base_url, 'username', 'password').url.should == base_url
     end
 
-    it 'should raise an error if Gnip returns HTTP error' do
-      stub_request(:post, base_url_with_auth).
-          with(:body => '{"rules":[{"value":"value","tag":"tag"}]}').
-          to_return(:status => 401, :body => 'Error message', :headers => {})
-      lambda { subject.add('value', 'tag') }.should raise_error
-    end
   end
 
-  describe '#delete' do
-    it 'should POST rule json to a URL with given credentials' do
-      stub_request(:post, "#{base_url_with_auth}?_method=delete").
-          with(:body => '{"rules":[{"value":"value","tag":"tag"}]}').
-          to_return(:status => 200, :body => '', :headers => {})
-      subject.delete('value', 'tag')
-    end
-  end
+  describe 'instance' do
+    subject { GnipRule::Client.new(base_url, 'username', 'password') }
 
-  describe '#list' do
-    it 'should GET a URL with given credentials' do
-      stub_request(:get, base_url_with_auth).
-          to_return(:status => 200, :body => '{"rules":[{"value":"foo","tag":"baz"},{"value":"bar","tag":"baz"}]}')
-      rules = subject.list()
-      rules.size.should == 2
-      rules.map { |r| r.valid?.should == true }
-    end
+    describe '#add' do
+      it 'should POST rule to the given URL with given credentials' do
+        stub_request(:post, base_url_with_auth).
+            with(:body => '{"rules":[{"value":"value","tag":"tag"}]}').
+            to_return(:status => 200, :body => '', :headers => {})
+        subject.add('value', 'tag')
+      end
 
-    it 'should raise an error if Gnip returns HTTP error' do
-      stub_request(:get, base_url).
-          with(:body => '{"rules":[{"value":"value","tag":"tag"}]}').
-          to_return(:status => 401, :body => 'Error message', :headers => {})
-      lambda { subject.list() }.should raise_error
+      it 'should raise an error if Gnip returns HTTP error' do
+        stub_request(:post, base_url_with_auth).
+            with(:body => '{"rules":[{"value":"value","tag":"tag"}]}').
+            to_return(:status => 401, :body => 'Error message', :headers => {})
+        lambda { subject.add('value', 'tag') }.should raise_error
+      end
     end
-  end
 
-  describe '#jsonify_rules' do
-    it 'should JSONify Strings' do
-      json = subject.jsonify_rules('foo', 'bar')
-      json.should == '{"rules":[{"value":"foo","tag":"bar"}]}'
+    describe '#delete' do
+      it 'should POST rule json to a URL with given credentials' do
+        stub_request(:post, "#{base_url_with_auth}?_method=delete").
+            with(:body => '{"rules":[{"value":"value","tag":"tag"}]}').
+            to_return(:status => 200, :body => '', :headers => {})
+        subject.delete('value', 'tag')
+      end
     end
 
-    it 'should JSONify Rules' do
-      json = subject.jsonify_rules(GnipRule::Rule.new('baz', 'foo'))
-      json.should == '{"rules":[{"value":"baz","tag":"foo"}]}'
-    end
+    describe '#list' do
+      it 'should GET a URL with given credentials' do
+        stub_request(:get, base_url_with_auth).
+            to_return(:status => 200, :body => '{"rules":[{"value":"foo","tag":"baz"},{"value":"bar","tag":"baz"}]}')
+        rules = subject.list()
+        rules.size.should == 2
+        rules.map { |r| r.valid?.should == true }
+      end
 
-    it 'should JSONify an Array of Strings with a tag' do
-      json = subject.jsonify_rules(['foo', 'bar'], 'baz')
-      json.should == '{"rules":[{"value":"foo","tag":"baz"},{"value":"bar","tag":"baz"}]}'
+      it 'should raise an error if Gnip returns HTTP error' do
+        stub_request(:get, base_url).
+            with(:body => '{"rules":[{"value":"value","tag":"tag"}]}').
+            to_return(:status => 401, :body => 'Error message', :headers => {})
+        lambda { subject.list() }.should raise_error
+      end
     end
 
-    it 'should JSONify an Array of Rules' do
-      rule1 = GnipRule::Rule.new('baz', 'foo')
-      rule2 = GnipRule::Rule.new('bar', 'thing')
-      json = subject.jsonify_rules([rule1, rule2])
-      json.should == '{"rules":[{"value":"baz","tag":"foo"},{"value":"bar","tag":"thing"}]}'
+    describe '#jsonify_rules' do
+      it 'should JSONify Strings' do
+        json = subject.gen_json_payload('foo', 'bar')
+        json.should == '{"rules":[{"value":"foo","tag":"bar"}]}'
+      end
+
+      it 'should JSONify Rules' do
+        json = subject.gen_json_payload(GnipRule::Rule.new('baz', 'foo'))
+        json.should == '{"rules":[{"value":"baz","tag":"foo"}]}'
+      end
+
+      it 'should JSONify an Array of Strings with a tag' do
+        json = subject.gen_json_payload(['foo', 'bar'], 'baz')
+        json.should == '{"rules":[{"value":"foo","tag":"baz"},{"value":"bar","tag":"baz"}]}'
+      end
+
+      it 'should JSONify an Array of Rules' do
+        rule1 = GnipRule::Rule.new('baz', 'foo')
+        rule2 = GnipRule::Rule.new('bar', 'thing')
+        json = subject.gen_json_payload([rule1, rule2])
+        json.should == '{"rules":[{"value":"baz","tag":"foo"},{"value":"bar","tag":"thing"}]}'
+      end
     end
   end
 end

data/spec/gnip-rule/rule_spec.rb

@@ -6,7 +6,7 @@ describe GnipRule::Rule do
   describe '#initialize' do
     it 'should allow an optional tag' do
       rule = GnipRule::Rule.new('value')
-      rule.tag.should == nil
+      rule.tag.should be_nil
 
       rule_with_tag = GnipRule::Rule.new('value', 'tag')
       rule_with_tag.tag.should == 'tag'
@@ -15,43 +15,44 @@ describe GnipRule::Rule do
 
   describe '#valid?' do
     it 'should consider rules with "stop words" to be invalid' do
-      rule = GnipRule::Rule.new('an value')
-      rule.valid?.should == false
+      GnipRule::Rule.new('an value').should_not be_valid
     end
     it 'should consider rules that are too long to be invalid' do
       rule = GnipRule::Rule.new('01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789')
-      rule.valid?.should == false
+      rule.should_not be_valid
     end
     it 'should consider empty sources to be invalid' do
-      rule = GnipRule::Rule.new('foo source: bar')
-      rule.valid?.should == false
+      GnipRule::Rule.new('foo source: bar').should_not be_valid
     end
     it 'should consider negative ORs to be invalid' do
-      rule = GnipRule::Rule.new('-iphone OR ipad')
-      rule.valid?.should == false
+      GnipRule::Rule.new('-iphone OR ipad').should_not be_valid
     end
     it 'should consider rules with more than 10 positive terms invalid' do
-      rule = GnipRule::Rule.new('one two three four five six seven eight nine ten eleven')
-      rule.valid?.should == false
+      GnipRule::Rule.new('one two three four five six seven eight nine ten eleven').should_not be_valid
     end
     it 'should consider stop words within quotes to be valid' do
-      rule = GnipRule::Rule.new('"foo the bar" baz')
-      rule.valid?.should == true
+      GnipRule::Rule.new('"foo the bar" baz').should be_valid
     end
     it 'should consider rules without "stop words" to be valid' do
-      rule = GnipRule::Rule.new('value')
-      rule.valid?.should == true
+      GnipRule::Rule.new('value').should be_valid
     end
   end
 
-  describe '#as_json' do
+  describe '#to_json' do
     it 'should omit tag if tag not defined' do
       rule = GnipRule::Rule.new('foo')
-      rule.as_json.should == '{"value":"foo"}'
+      rule.to_json.should == '{"value":"foo"}'
     end
     it 'should add tag if defined' do
       rule = GnipRule::Rule.new('foo', 'bar')
-      rule.as_json.should == '{"value":"foo","tag":"bar"}'
+      rule.to_json.should == '{"value":"foo","tag":"bar"}'
+    end
+  end
+
+  describe '#to_rule' do
+    it 'should return itself' do
+      rule = GnipRule::Rule.new('foo', 'bar')
+      rule.to_rule.should == rule
     end
   end
 end

data/spec/spec-helper.rb

@@ -3,3 +3,5 @@ Bundler.setup
 
 require 'rspec'
 require 'webmock/rspec'
+
+WebMock.disable_net_connect!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gnip-rule
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake