gnip-rule 0.1.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.idea
+Gemfile.lock
+pkg/*
+.rbx

data/.pryrc

@@ -0,0 +1,2 @@
+$: << "/Users/eric/src/gnip-rule/lib/"
+require 'gnip-rule'

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@gnip-rule --create

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in gnip-rule.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Eric Wendelin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# gnip-rule
+Ruby library for working with the Gnip Rules API
+
+## Installation
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'gnip-rule', '~> 0.1.1'
+```
+
+## Example
+
+```ruby
+require 'gnip-rule'
+
+ruler = GnipRule::Client.new(GNIP_API_URL, GNIP_USERNAME, GNIP_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'))])
+
+# Same with delete
+ruler.delete('baz', 'tag')
+ruler.delete(['foo', 'bar'])
+ruler.delete(GnipRule::Rule.new('value', 'tag'))
+
+# Get all ruler as Rule objects
+ruler.list()
+```
+
+## License
+MIT License: http://www.opensource.org/licenses/mit-license.php

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/gnip-rule.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'gnip-rule/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'gnip-rule'
+  s.version     = GnipRule::VERSION
+
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Eric Wendelin']
+  s.email       = ['me@eriwen.com']
+  s.homepage    = 'https://github.com/eriwen/gnip-rule'
+  s.summary     = %q{Ruby library for working with the Gnip Rules API}
+  s.description = s.summary
+
+  s.rubyforge_project = 'gnip-rule'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec'
+
+  s.add_dependency 'curb', '>= 0.8.0', '< 0.9.0'
+  s.add_dependency 'json', '>= 1.6.0', '< 1.7.0'
+end

data/lib/gnip-rule.rb

@@ -0,0 +1,7 @@
+require 'gnip-rule/version'
+
+require 'gnip-rule/rule'
+require 'gnip-rule/client'
+
+module GnipRule
+end

data/lib/gnip-rule/client.rb

@@ -0,0 +1,64 @@
+require 'curb'
+require 'json'
+require 'gnip-rule/rule'
+
+module GnipRule
+  class Client
+
+    attr_reader :url, :username, :password
+
+    def initialize(url, username, password)
+      @url = url.gsub(/\.xml$/, '.json')
+      @username = username
+      @password = password
+    end
+
+    def add(value, tag=nil)
+      post(@url, jsonify_rules(value, tag))
+    end
+
+    def delete(value, tag=nil)
+      post("#{@url}?_method=delete", jsonify_rules(value, tag))
+    end
+
+    def list()
+      rules = nil
+      Curl::Easy.http_get(@url) do |curl|
+        curl.http_auth_types = :basic
+        curl.username = @username
+        curl.password = @password
+        curl.on_body do |obj|
+          rules = JSON.parse(obj)['rules'].collect { |o| Rule.new(o['value'], o['tag']) }
+          obj.size
+        end
+      end
+      rules
+    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
+    end
+
+    protected
+    def post(url, data)
+      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}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gnip-rule/rule.rb

@@ -0,0 +1,56 @@
+require 'json'
+
+module GnipRule
+  class Rule
+    attr_accessor :value, :tag
+
+    def initialize(value, tag=nil)
+      @value = value
+      @tag = tag
+    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
+      true
+    end
+
+    def as_json
+      as_hash.to_json
+    end
+
+    def as_hash
+      obj = {:value => @value}
+      obj[:tag] = @tag unless @tag.nil?
+      obj
+    end
+
+    def to_s
+      as_json
+    end
+
+    protected
+    def contains_stop_word?(value)
+      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
+    end
+
+    def too_long?(value)
+      value.size > 1024
+    end
+
+    def contains_negated_or?(value)
+      !value[/\-\w+ OR/].nil?
+    end
+
+    def too_many_positive_terms?(value)
+      value.scan(/\b\w+|\"[\-\s\w]+\"\b/).size > 10
+    end
+
+    def contains_empty_source?(value)
+      !value[/source\:\s/].nil?
+    end
+  end
+end

data/lib/gnip-rule/version.rb

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

data/spec/gnip-rule/client_spec.rb

@@ -0,0 +1,66 @@
+require 'spec-helper'
+
+require 'gnip-rule/client'
+
+describe GnipRule::Client do
+  let(:fake_curb) { double("Curl::Easy") }
+  before do
+    Curl::Easy.stub(:http_post => fake_curb)
+    Curl::Easy.stub(:http_get => fake_curb)
+  end
+
+  subject { GnipRule::Client.new('https://api.gnip.com:443/accounts/foo/publishers/twitter/streams/track/prod/rules.json', 'username', 'password') }
+
+  describe '#initialize' do
+    it 'should convert XML URLs to JSON' do
+      subject.url.should == 'https://api.gnip.com:443/accounts/foo/publishers/twitter/streams/track/prod/rules.json'
+    end
+  end
+
+  describe '#add' do
+    it 'should POST rule to the given URL with given credentials' 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
+    it 'should POST rule json to a URL with given credentials' do
+      Curl::Easy.should_receive(:http_post)
+      subject.delete('value', 'tag')
+    end
+  end
+
+  describe '#list' do
+    it 'should GET a URL with given credentials' do
+      Curl::Easy.should_receive(:http_get)
+      subject.list()
+    end
+  end
+
+  describe '#jsonify_rules' do
+    it 'should JSONify Strings' do
+      json = subject.jsonify_rules('foo', 'bar')
+      json.should == '{"rules":[{"value":"foo","tag":"bar"}]}'
+    end
+
+    it 'should JSONify Rules' do
+      json = subject.jsonify_rules(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.jsonify_rules(['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.jsonify_rules([rule1, rule2])
+      json.should == '{"rules":[{"value":"baz","tag":"foo"},{"value":"bar","tag":"thing"}]}'
+    end
+  end
+end

data/spec/gnip-rule/rule_spec.rb

@@ -0,0 +1,57 @@
+require 'spec-helper'
+
+require 'gnip-rule/rule'
+
+describe GnipRule::Rule do
+  describe '#initialize' do
+    it 'should allow an optional tag' do
+      rule = GnipRule::Rule.new('value')
+      rule.tag.should == nil
+
+      rule_with_tag = GnipRule::Rule.new('value', 'tag')
+      rule_with_tag.tag.should == 'tag'
+    end
+  end
+
+  describe '#valid?' do
+    it 'should consider rules with "stop words" to be invalid' do
+      rule = GnipRule::Rule.new('an value')
+      rule.valid?.should == false
+    end
+    it 'should consider rules that are too long to be invalid' do
+      rule = GnipRule::Rule.new('01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789')
+      rule.valid?.should == false
+    end
+    it 'should consider empty sources to be invalid' do
+      rule = GnipRule::Rule.new('foo source: bar')
+      rule.valid?.should == false
+    end
+    it 'should consider negative ORs to be invalid' do
+      rule = GnipRule::Rule.new('-iphone OR ipad')
+      rule.valid?.should == false
+    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
+    end
+    it 'should consider stop words within quotes to be valid' do
+      rule = GnipRule::Rule.new('"foo the bar" baz')
+      rule.valid?.should == true
+    end
+    it 'should consider rules without "stop words" to be valid' do
+      rule = GnipRule::Rule.new('value')
+      rule.valid?.should == true
+    end
+  end
+
+  describe '#as_json' do
+    it 'should omit tag if tag not defined' do
+      rule = GnipRule::Rule.new('foo')
+      rule.as_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"}'
+    end
+  end
+end

data/spec/spec-helper.rb

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler.setup
+
+require 'rspec'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: gnip-rule
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric Wendelin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: Ruby library for working with the Gnip Rules API
+email:
+- me@eriwen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gnip-rule.gemspec
+- lib/gnip-rule.rb
+- lib/gnip-rule/client.rb
+- lib/gnip-rule/rule.rb
+- lib/gnip-rule/version.rb
+- spec/gnip-rule/client_spec.rb
+- spec/gnip-rule/rule_spec.rb
+- spec/spec-helper.rb
+homepage: https://github.com/eriwen/gnip-rule
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: gnip-rule
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby library for working with the Gnip Rules API
+test_files:
+- spec/gnip-rule/client_spec.rb
+- spec/gnip-rule/rule_spec.rb
+- spec/spec-helper.rb