finviz_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0874b31646a0e5a6c49aa9bbeb9686a26d9fa511
+  data.tar.gz: 63ccebdadb48d0a0c5b53fc91d648aa9642e3abc
+SHA512:
+  metadata.gz: 5013eeab0c5f1331857876c60a93c0ad3ed5d568fc0df060884beb7d33067e1d1689ecebb4e148d7945b9ccd28e8365a3d8d63540ccdefa99ae921d96ddb0b23
+  data.tar.gz: 11bf44aeb1d002518a05d14b615deebdbc5614f64e0e135fbb05cff9a113456d39a5252561ea4a38d03a82bfe5a43ce936218eebc05ee0c8320dbe4b73e8e9d1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Nemrow
+
+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,31 @@
+= FinvizRails
+
+    gem 'finviz_rails', git: 'https://github.com/nemrow/finviz_rails.git'
+
+
+== To Use
+
+without finviz authentication (not finviz elite)
+
+    finviz = Finviz.new
+
+with authentication (using finviz elite)
+
+    finviz = Finviz.new(finviz_username, finviz_password)
+
+    // You can also set FINVIZ_USERNAME and FINVIZ_PASSWORD
+    // environment variables instead
+
+to screen stocks
+
+    finviz.screener(
+      pattern: "wedge",
+      order: "-change",
+      signal: "toplosers",
+      max_stock_count: 20
+    )
+
+avialable options:
+
+    price_range, analyst_recommendation, volatility,
+    average_volume, pattern, country, current_volume

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FinvizRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/finviz_rails.rb

@@ -0,0 +1,10 @@
+require "finviz_rails/finviz"
+require "finviz_rails/login"
+require "finviz_rails/screener"
+require "finviz_rails/url_formatter"
+require "finviz_rails/filter_mapper"
+require "finviz_rails/indices"
+
+module FinvizRails
+end
+

data/lib/finviz_rails/filter_mapper.rb

@@ -0,0 +1,41 @@
+class FilterMapper
+  def initialize(*params)
+    @params = params.first
+    @param_components = []
+  end
+
+  def run
+    mapper.each do |key, value|
+      @param_components << "#{value}_#{@params[key]}" if @params[key]
+    end
+    @param_components.join(",")
+  end
+
+  private
+
+  def mapper
+    {
+      price_range: "sh_price",
+      analyst_recommendation: "an_recom",
+      volatility: "ta_volatility",
+      average_volume: "sh_avgvol",
+      pattern: "ta_pattern",
+      country: "geo",
+      current_volume: "sh_curvol",
+      simple_moving_average_20_day: "ta_sma20",
+      simple_moving_average_50_day: "ta_sma50",
+      simple_moving_average_200_day: "ta_sma200",
+      current_ratio: "fa_curratio",
+      performance: "ta_perf",
+      sector: "sec",
+      insider_ownership: "sh_insiderown",
+      industry: "ind",
+      insider_transactions: "sh_insidertrans",
+      change: "ta_change",
+      institutional_ownership: "sh_instown",
+      gap: "ta_gap",
+      change_from_open: "ta_changeopen",
+      candlestick: "ta_candlestick"
+    }
+  end
+end

data/lib/finviz_rails/finviz.rb

@@ -0,0 +1,34 @@
+require 'httparty'
+require 'mechanize'
+
+class Finviz
+  include HTTParty
+
+  attr_accessor :authenticated
+
+  def initialize(username=nil, password=nil)
+    @username = ENV['FINVIZ_USERNAME'] || username
+    @password = ENV['FINVIZ_PASSWORD'] || password
+    login if @username && @password
+  end
+
+  def screener(params)
+    Screener.new(agent, @authenticated, params).run
+  end
+
+  def indices
+    Indices.new(agent, @authenticated).run
+  end
+
+  private
+
+
+  def login
+    @authenticated = true
+    Login.new(@username, @password, agent).run
+  end
+
+  def agent
+    @agent ||= Mechanize.new
+  end
+end

data/lib/finviz_rails/indices.rb

@@ -0,0 +1,35 @@
+class Indices
+  def initialize(agent, auth, *params)
+    @agent = agent
+    @auth = auth
+    @results = {}
+  end
+
+  def run
+    @agent.get(url)
+    matches.map do |match|
+      indice = get_indice(match.first)
+      percent_change = get_percent(match.first)
+      @results[indice] = percent_change
+    end
+    @results
+  end
+
+  private
+
+  def get_indice(string)
+    string.match(/^"(.+?)"/)[1]
+  end
+
+  def get_percent(string)
+    string.match(/change":(\d*\.?\d*)/)[1].to_f
+  end
+
+  def url
+    "http://#{'elite.' if @auth}finviz.com/futures_charts.ashx?t=INDICES&p=d1"
+  end
+
+  def matches
+    @agent.page.content.scan /{"label":(.+?),"sparkline"/
+  end
+end

data/lib/finviz_rails/login.rb

@@ -0,0 +1,25 @@
+class Login
+  def initialize(username, password, agent)
+    @username = username
+    @password = password
+    @agent = agent
+  end
+
+  def run
+    go_to_login_page
+    form['email'] = @username
+    form['password'] = @password
+    form.submit
+    @agent
+  end
+
+  private
+
+  def go_to_login_page
+    @agent.get("http://finviz.com/login.ashx")
+  end
+
+  def form
+    @form ||= @agent.page.forms[1]
+  end
+end

data/lib/finviz_rails/screener.rb

@@ -0,0 +1,74 @@
+class Screener
+  def initialize(agent, auth, *params)
+    @agent = agent
+    @auth = auth
+    @params = params.first
+    @stocks = []
+  end
+
+  def run
+    @agent.get(url)
+    set_pagination_count
+    set_found_stock_count
+    add_stocks_from_page(@agent.page.parser)
+    if @pagination_count
+      (2..@pagination_count).each do |page_num|
+        break if max_stock_count && @stocks.count >= max_stock_count
+        @agent.get url(page_num)
+        add_stocks_from_page(@agent.page.parser)
+      end
+    end
+    results
+  end
+
+  private
+
+  def results
+    {
+      found_stock_count: @found_stock_count,
+      returned_stock_count: @stocks.count,
+      stocks: @stocks
+    }
+  end
+
+  def set_found_stock_count
+    @found_stock_count = begin
+      text = @agent.page.parser.css('.count-text').text
+      match = text.match /Total: (\d+)/
+      match[1]
+    end
+  end
+
+  def max_stock_count
+    @params[:max_stock_count]
+  end
+
+  def set_pagination_count
+    @pagination_count ||= begin
+      pages = @agent.page.parser.css('a.screener-pages')
+      pages.any? ? pages.last.text.to_i : nil
+    end
+  end
+
+  def add_stocks_from_page(html)
+    rows = html.css('#screener-content > table > tr:nth-child(4) tr')
+    headers = rows.shift
+    stocks = rows.map do |row|
+      stock = {}
+      row.css('td').each_with_index do |td, index|
+        header = format_header(headers.css('td')[index].text)
+        stock[header] = td.text
+      end
+      stock
+    end
+    @stocks.concat stocks
+  end
+
+  def format_header(header)
+    header.gsub('.','').gsub('/','_').gsub(' ','').downcase
+  end
+
+  def url(page=nil)
+    UrlFormatter.new(@auth, page, @params).run
+  end
+end

data/lib/finviz_rails/url_formatter.rb

@@ -0,0 +1,42 @@
+class UrlFormatter
+  def initialize(auth, page, params)
+    @auth = auth
+    @page = page
+    @params = params
+  end
+
+  def run
+    if @page
+      stock_num = ((@page * 20) + 1) - 20
+    else
+      stock_num = 0
+    end
+    "#{url}&r=#{stock_num}"
+  end
+
+  private
+
+  def url
+    @url ||= [base_url, signal, filters, order, tickers].join("&")
+  end
+
+  def signal
+    "s=#{@params[:signal]}"
+  end
+
+  def filters
+    "f=#{FilterMapper.new(@params).run}"
+  end
+
+  def order
+    "o=#{@params[:order]}"
+  end
+
+  def tickers
+    "t=#{@params[:tickers].join(',')}"
+  end
+
+  def base_url
+    "http://#{'elite.' if @auth}finviz.com/screener.ashx?v=111"
+  end
+end

data/lib/finviz_rails/version.rb

@@ -0,0 +1,3 @@
+module FinvizRails
+  VERSION = "0.0.1"
+end

data/lib/tasks/finviz_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :finviz_rails do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */