Giter VIP home page Giter VIP logo

gnip-rules's Introduction

gnip-rules

Provides a quick and easy way to manage your rules via Gnip Rules API.

Installation

 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( "[email protected]", "larl!operator" ,'https://stream.gnip.com/.../YOUR_ACCOUNT/.../prod' )

  • Via a configuration file at config/gnip.yml

 development: &development
   username: [email protected]
   password: larl!operator 
   streaming_url:'https://stream.gnip.com:443/accounts/YOUR_ACCOUNT/publishers/twitter/streams/track/prod'

Usage

 @gnip_rules = Gnip::Rules.new

Adding

  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

  rules = [Gnip::Rule.new "larl -bang", Gnip::Rule.new "#larloperator"]
  response = @gnip_rules.remove( rules )
  p response #=> 200 OK

Listing

  response = @gnip_rules.list.rules
  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. This method loads all the rules from gnip and passes them to the remove method. There is a 3 second pause in between the list and delete to avoid rate limiting.

  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

 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.