gnip-rules 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'httparty'
+gem 'rake'
+gem 'json'
+gem 'activesupport'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'shoulda-context'
+  gem 'turn'
+  gem 'assert2'
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Spencer Markowski
+
+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,90 @@
+# gnip-rules
+
+Provides a quick and easy way to manage your rules via Gnip Rules API. 
+
+## Installation
+
+```ruby
+ gem 'gnip-rules'
+```
+
+## Configuration
+
+There are two ways you can provide credentials to the gnip-api gem. 
+
+* Pass them to the initialize method
+
+  `Gnip::Rules.new( "chieflarl@larlbang.com", "larl!operator" ,'https://stream.gnip.com/.../YOUR_ACCOUNT/.../prod' )`
+
+* Via a configuration file at config/gnip.yml 
+
+```yaml
+ development: &development
+   username: chieflarl@larlbang.com
+   password: larl!operator 
+   streaming_url:'https://stream.gnip.com:443/accounts/YOUR_ACCOUNT/publishers/twitter/streams/track/prod'
+```
+
+## Usage
+
+```ruby
+ @gnip_rules = Gnip::Rules.new
+```
+
+### Adding
+
+```ruby
+  rules = [Gnip::Rule.new "larl -bang", Gnip::Rule.new "#larloperator", Gnip::Rule.new "larlygag" , "some_tag"]
+  response = @gnip_rules.add( rules )
+  p response #=> 201 Created
+```
+
+### Removing
+
+```ruby
+  rules = [Gnip::Rule.new "larl -bang", Gnip::Rule.new "#larloperator"]
+  response = @gnip_rules.remove( rules )
+  p response #=> 200 OK
+```
+
+### Listing
+
+```ruby
+  response = @gnip_rules.list
+  p response #=> {"rules": {"value":"larl -bang", "value":"#larloperator"} }
+```
+
+### Removing All Rules
+
+This is really just for convienience while testing. You probably shouldn't ever use this in production.
+
+```ruby
+  response = @gnip_rules.delete_all!
+  p response #=> 200 OK
+  @gnip.list["rules"].empty? #=> true
+```
+
+## Running Tests
+
+Make sure you have the config file mentioned above at config/gnip.yml
+
+```ruby
+ rake test
+```
+
+## Contributing to gnip-rules
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 The Able Few. See LICENSE.txt for
+further details.
+
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "gnip-rules"
+  gem.homepage = "http://github.com/theablefew/gnip-rules"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple wrapper for the Gnip Rules API}
+  gem.description = %Q{Remove, Add and List your Gnip Rules}
+  gem.email = "spencer@theablefew.com"
+  gem.authors = ["Spencer Markowski", "The Able Few"]
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/gnip-rules.rb

@@ -0,0 +1,96 @@
+require 'active_support'
+require 'httparty'
+require 'json'
+
+module Gnip
+  class Rules
+    include HTTParty
+
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/json'
+    format :json
+
+    def initialize( username = nil, password = nil, uri = nil )
+      unless username && password && uri
+        load_credentials!
+        username = @config["username"]
+        password = @config["password"]
+        uri = @config["streaming_url"]
+      end
+
+      self.class.basic_auth username , password 
+      self.class.base_uri uri
+    end
+
+    def add(rules)
+      options = ActiveSupport::JSON.encode( {:rules => rules} )
+      puts options
+      self.class.post('/rules.json', :body => options )
+    end
+
+    def remove( rules )
+      options = ActiveSupport::JSON.encode( {:rules => rules} )
+      self.class.delete('/rules.json', :body => options )
+    end
+
+    def list
+      self.class.get( '/rules.json' )
+    end
+
+    def delete_all!
+      rules = self.list["rules"]
+      self.remove( rules )
+    end
+
+    private
+
+    def load_credentials!
+      if File.exists?( 'config/gnip.yml' )
+         @config = YAML.load_file( "config/gnip.yml" )[environment.to_s]
+         puts "c: #{@config}"
+      else
+        raise Exception.new( <<-RUBY
+          You must provide a configuration file at config/gnip.yml
+
+            development: &development
+              username: omg@omg.com 
+              password: larl! 
+              account: larloperator
+              streaming_url: 'https://stream.gnip.com:443/accounts/YOUR_ACCOUNT/publishers/twitter/streams/track/prod/'
+
+        RUBY
+        )
+      end
+    end
+
+    def environment
+      #Clearly there's a better way. 
+      if defined?(Rails)
+        Rails.env
+      elsif defined?(RAILS_ENV)
+        RAILS_ENV
+      elsif defined?(RACK_ENV)
+        RACK_ENV
+      else
+        :development
+      end
+    end
+
+    # -Rules
+  end
+
+  class Rule
+    attr_accessor :value, :tag 
+
+    def initialize( v , t = nil )
+      @value = v
+      @tag = t
+    end
+    
+    def to_json
+      o = {"value" => value}
+      o.merge!( "tag" => tag ) unless tag.nil?
+      JSON.generate( o )
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+  Bundler.require( :default, :development )
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'logger'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gnip-rules'
+
+class Test::Unit::TestCase
+  def logger
+    Logger.new(STDOUT)
+  end
+
+end

data/test/test_gnip-rules.rb

@@ -0,0 +1,36 @@
+require 'helper'
+
+class TestGnipRules < Test::Unit::TestCase
+  context 'Gnip' do 
+    setup do 
+      @gnip = Gnip::Rules.new
+    end
+
+    should "allow creation of rules" do
+      response = @gnip.add([Gnip::Rule.new( '"new spyro"' )])
+      assert{ response.response.class == Net::HTTPCreated }
+    end
+
+    should 'allow removal of rules' do 
+     response = @gnip.remove([Gnip::Rule.new( '"new spyro"' )])
+     assert{ response.response.class == Net::HTTPOK }
+    end
+
+    should 'allow creation of tagged rules' do 
+      response = @gnip.add([ Gnip::Rule.new('#skylanders -skylanders -spyro', 'Skylanders')])
+      assert{ response.response.class == Net::HTTPCreated }
+    end
+
+    should 'list all rules' do
+      response = @gnip.list
+      assert{ response.response.class == Net::HTTPOK }
+    end
+
+    should 'delete all rules' do 
+      response = @gnip.delete_all!
+      assert{ response.response.class == Net::HTTPOK }
+      assert{ @gnip.list["rules"].empty? }
+    end
+
+  end
+end

data/test/test_rule.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+class TestRule < Test::Unit::TestCase
+  context "Gnip Rules" do 
+    context "without tags" do
+      setup do 
+        @rule = Gnip::Rule.new( '"bangor slov"')
+      end
+
+      should "allow creation of quoted rule" do
+        assert{ @rule.value == "\"bangor slov\"" }
+        assert{ @rule.to_json == "{\"value\":\"\\\"bangor slov\\\"\"}" }
+        assert{ JSON.parse( @rule.to_json )["value"] == "\"bangor slov\"" }
+      end
+
+      should 'not have tag key as json' do
+        assert{ @rule.to_json == "{\"value\":\"\\\"bangor slov\\\"\"}" }
+        assert{ JSON.parse( @rule.to_json )["tag"].nil? }
+      end
+
+      should 'not have a tag value' do
+        assert{ @rule.tag.nil? }
+      end
+    end
+
+    context "with tags" do
+      setup do
+        @rule = Gnip::Rule.new( "gorgon" , "scary" )
+      end
+
+      should "convert to json" do
+        assert{ JSON.parse( @rule.to_json )['tag'] == "scary" }
+        assert{ JSON.parse( @rule.to_json )['value'] == "gorgon" }
+      end
+
+      should "have a tag value" do 
+        assert{ @rule.tag == "scary" }
+      end
+
+    end
+  end
+end
+

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: gnip-rules
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Spencer Markowski
+- The Able Few
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70314327301400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314327301400
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70314327454480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314327454480
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70314327533960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314327533960
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70314327532360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314327532360
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: &70314327529900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70314327529900
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70314327556440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70314327556440
+- !ruby/object:Gem::Dependency
+  name: assert2
+  requirement: &70314327555220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70314327555220
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70314327553660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70314327553660
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70314327552260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70314327552260
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70314327550220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70314327550220
+description: Remove, Add and List your Gnip Rules
+email: spencer@theablefew.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/gnip-rules.rb
+- test/helper.rb
+- test/test_gnip-rules.rb
+- test/test_rule.rb
+homepage: http://github.com/theablefew/gnip-rules
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1745993365718660061
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for the Gnip Rules API
+test_files: []