stocktwits-api 0.1.1

data/.document

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.4)
+    faraday (0.7.0)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.1)
+    minitest (2.2.2)
+    multipart-post (1.1.2)
+    rack (1.2.2)
+    rake (0.9.1)
+    rcov (0.9.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  faraday
+  jeweler (~> 1.6.0)
+  json
+  minitest
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Larry Staton Jr.
+
+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.rdoc

@@ -0,0 +1,29 @@
+= stocktwits-api
+
+A wrapper for the StockTwits API.
+
+== Usage
+
+Query the StockTwits API for streams, user streams, and symbol streams:
+
+require 'stocktwits'
+
+StockTwits.stream("all") # JSON object with messages from the all stream
+StockTwits.user("stocktwits") # JSON object with messages from the stocktwits stream
+StockTwits.symbol("AAPL") # JSON object with messages from the AAPL stream
+StockTwits.symbol("AAPL,MSFT") # JSON object with messages from the AAPL stream and MSFT stream
+
+== Contributing to stocktwits-api
+
+* 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 Larry Staton Jr. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# 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 = "stocktwits-api"
+  gem.homepage = "http://github.com/statonjr/stocktwits-api"
+  gem.license = "MIT"
+  gem.summary = %Q{A wrapper for the StockTwits API.}
+  gem.description = %Q{StockTwits is a financial idea network.}
+  gem.email = "statonjr@gmail.com"
+  gem.authors = ["Larry Staton Jr."]
+  # dependencies defined in Gemfile
+  gem.add_dependency "faraday"
+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
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stocktwits #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/stocktwits.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+require 'json'
+require 'stocktwits/errors.rb'
+
+module StockTwits
+
+  BASE_URL = "http://api.stocktwits.com"
+
+  @connection = Faraday.new(:url => BASE_URL) do |builder|
+    builder.use Faraday::Response::StockTwitsErrors
+    builder.adapter Faraday.default_adapter
+  end
+
+  def self.stream(name="public")
+
+    response = @connection.get("/api/streams/#{name}.json")
+    response.body
+
+  end
+
+  def self.user(name="stocktwits")
+
+    response = @connection.get "/api/streams/user/#{name}.json"
+    response.body
+
+  end
+
+  def self.symbol(name="AAPL")
+
+    if name && name.split(",").length > 1
+      response = @connection.get("/api/streams/symbols.json?symbols=#{name}")
+    else
+      response = @connection.get("/api/streams/symbol/#{name}.json")
+    end
+
+    response.body
+
+  end
+
+end

data/lib/stocktwits/errors.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+module Faraday
+  class Response::StockTwitsErrors < Response::Middleware
+
+    def initialize(app)
+      super app
+    end
+
+    def call(env)
+      # Handle request
+
+      # Always call super last
+      super
+    end
+
+    def on_complete(env)
+      # Handle response
+      body = JSON.parse(env[:body])
+      status = body["response"]["status"]
+      case status
+      when 200
+        env[:body]
+      else
+        env[:body] = body["errors"][0]
+      end
+    end
+
+  end
+end

data/stocktwits-api.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stocktwits-api}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Larry Staton Jr."]
+  s.date = %q{2011-06-05}
+  s.description = %q{StockTwits is a financial idea network.}
+  s.email = %q{statonjr@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/stocktwits.rb",
+    "lib/stocktwits/errors.rb",
+    "stocktwits-api.gemspec",
+    "test/helper.rb",
+    "test/test_stocktwits.rb"
+  ]
+  s.homepage = %q{http://github.com/statonjr/stocktwits-api}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A wrapper for the StockTwits API.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faraday>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<faraday>, [">= 0"])
+    else
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<faraday>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<faraday>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,15 @@
+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 'minitest/autorun'
+require 'minitest/pride'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'stocktwits'

data/test/test_stocktwits.rb

@@ -0,0 +1,73 @@
+require 'helper'
+
+# class TestStocktwits < MiniTest::Spec
+describe StockTwits do
+
+  describe "streams" do
+    it "should return the public stream by default" do
+      response = StockTwits.stream
+      wont_be_empty response
+      response.must_match /messages/
+    end
+
+    it "should return the stream for the argument" do
+      response = StockTwits.stream("all")
+      wont_be_empty response
+      response.must_match /messages/
+    end
+
+    it "should display error message when invalid stream" do
+      response = StockTwits.stream("moose")
+      wont_be_empty response
+      response.must_equal "Authentication error"
+    end
+  end
+
+  describe "user streams" do
+    it "should return the stream for user stocktwits by default" do
+      response = StockTwits.user
+      wont_be_empty response
+      response.must_match /messages/
+    end
+
+    it "should return the stream for the user in the argument" do
+      response = StockTwits.user("statonjr")
+      wont_be_empty response
+      response.must_match /messages/
+    end
+
+    it "should display helpful message when invalid username" do
+      response = StockTwits.user("poppycock")
+      wont_be_empty response
+      response.must_equal "User not found"
+    end
+  end
+
+  describe "symbol streams" do
+    it "should return the stream for AAPL by default" do
+      response = StockTwits.symbol
+      wont_be_empty response
+      response.must_match /AAPL/
+    end
+
+    it "should return the stream for the symbol in the arguments" do
+      response = StockTwits.symbol("MSFT")
+      wont_be_empty response
+      response.must_match /MSFT/
+    end
+
+    it "should return the streams for multiple symbols passed in" do
+      response = StockTwits.symbol("AAPL,MSFT")
+      wont_be_empty response
+      response.must_match /AAPL/
+      response.must_match /MSFT/
+    end
+
+    it "should display helpful message when invalid argument" do
+      response = StockTwits.symbol("SPEA")
+      wont_be_empty response
+      response.must_equal "Symbol not found"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: stocktwits-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Larry Staton Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-05 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &2152854960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152854960
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2152854240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152854240
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152853520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152853520
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152852800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152852800
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2152852120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152852120
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &2152851420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152851420
+description: StockTwits is a financial idea network.
+email: statonjr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/stocktwits.rb
+- lib/stocktwits/errors.rb
+- stocktwits-api.gemspec
+- test/helper.rb
+- test/test_stocktwits.rb
+has_rdoc: true
+homepage: http://github.com/statonjr/stocktwits-api
+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: 1545794505768486286
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A wrapper for the StockTwits API.
+test_files: []