psei 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 419a46c16e6473e81f1ad1e25e2e27c6284aa13e
+  data.tar.gz: 9d3c2d9225cd44352414665c58f2dcde944d3dd4
+SHA512:
+  metadata.gz: 6d793f3554192fe2bbccec6719f9b48fd2598e7dc991e3a1c3cc2dd729a94932c1b1753bec0f95c2e857854e3289cc1417973f54a8ab31e72b89bc2617b44220
+  data.tar.gz: 5c15c8a83da144dca6592452d2c571fffa4a8d793b0a26bed6df7f29856aba0b799068e1b4b70bf0c0c9524d612900af4f74427e3fa457aac2e98bc945686a47

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marvin Baltazar
+
+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,116 @@
+# PSEI
+
+This gem fetches the end-of-day values of the Philippine Stock Exchange (PSE).
+More details available at their website [www.pse.com.ph](http://www.pse.com.ph/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'psei'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install psei
+
+## Usage
+
+There are two main components in this library, the `Security` module and the `Index` module.
+
+### Psei::Security
+
+This module is used to get the end-of-day values of all securities in the PSE. The main identifier of these securities are their symbols or tickers. For example, the Philippine Long Distance Telephone Company is defined by their symbol `TEL`.
+
+First, we need to initialize the module:
+
+`@sec = Psei::Security.new`
+
+To get the list of all symbols available:
+
+`@sec.symbols`
+
+This returns an array of all symbols (as strings), sorted by alphabetical order.
+
+To get the values of a specific security:
+
+`@sec.value('TEL')`
+
+This returns a Hash containing the following information:
+
+* symbol (String) - The security symbol 
+* alias (String) - The company identifier 
+* total_volume (Float) - Total number of traded volume of the day 
+* updown (String) - Identifies if the security has gone up or down in value
+* percent_change (Float) - Percentage that the security has changed
+* last_price (Float) - The last traded price of the security
+
+To get the values of all securities in a single call:
+
+`@sec.values`
+
+This returns an array of Hashes, each containing the same information when getting the values of a single security.
+
+Note that these values are only applicable to a specific trading day. To get the date of these values:
+
+`@sec.date`
+
+
+### Psei::Index
+
+This module is used to get the end-of-day values of all indices in the PSE. This includes the main index (PSEi), as well as industry-specific indices (Financial, Holdings, Mining, Services, etc).
+
+First, we need to initialize the module:
+
+`@ind = Psei::Index.new`
+
+To get the list of all symbols available:
+
+`@ind.symbols`
+
+This returns an array of all symbols (as strings).
+
+To get the values of a specific index:
+
+`@ind.value('PSE')`
+
+This returns a Hash containing the following information:
+
+* symbol (String) - The index symbol 
+* alias (String) - The index identifier 
+* total_volume (Float) - Total number of traded volume of the day 
+* updown (String) - Identifies if the index has gone up or down in value
+* percent_change (Float) - Percentage that the index has changed
+* last_price (Float) - The last traded price of the index
+
+To get the values of all indices in a single call:
+
+`@ind.values`
+
+This returns an array of Hashes, each containing the same information when getting the values of a single index.
+
+Note that these values are only applicable to a specific trading day. To get the date of these values:
+
+`@ind.date`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marvs/psei. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "psei"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/psei.rb

@@ -0,0 +1,14 @@
+require "date"
+require "psei/version"
+require "psei/parser"
+require "psei/formatter"
+require "psei/security"
+require "psei/index"
+require "psei/date"
+
+module Psei
+  SOURCE_URL = "http://pse.com.ph/stockMarket/home.html?method=getSecuritiesAndIndicesForPublic&ajax=true"
+  HEADING_ALIAS = "Stock Update As of"
+  INDEX_ALIASES = [ "PSEi", "All Shares", "Financials", "Industrial", "Holding Firms", "Property", 
+                    "Services", "Mining and Oil"].freeze
+end

data/lib/psei/date.rb

@@ -0,0 +1,33 @@
+# Based on the parsed request, gets the date of the values
+class Psei::Date
+  DATE_IDENTIFIER = "DATE"
+  DATETIME_FORMAT = '%m/%d/%Y %H:%M %p%z'
+  
+  def initialize parsed
+    @parsed = parsed
+    @parsed_time = nil
+  end
+  
+  def get
+    parse_time.to_date
+  end
+  
+  def get_datetime
+    parse_time
+  end
+  
+  private
+  
+  def date_filter
+    @parsed.select{|x| x["lastTradedPrice"] == DATE_IDENTIFIER}.first
+  end
+  
+  def date_string
+    date_str = date_filter["securityAlias"]
+    date_str << "+0800"
+  end
+  
+  def parse_time
+    @parsed_time ||= DateTime.strptime(date_string, DATETIME_FORMAT)
+  end
+end

data/lib/psei/formatter.rb

@@ -0,0 +1,49 @@
+# Formats the parsed data
+class Psei::Formatter
+  
+  def initialize
+    @arr = []
+  end
+  
+  def process arr
+    @arr = arr
+    @arr ? to_hash : {}
+  end
+  
+  private
+  
+  def int_format val
+    val.to_s.gsub(',', '').to_i
+  end
+  
+  def float_format val
+    val.to_s.gsub(',','').to_f
+  end
+  
+  def get_total_volume
+    float_format @arr['totalVolume']
+  end
+  
+  def get_percent_change
+    float_format @arr['percChangeClose']
+  end
+  
+  def get_last_price
+    float_format @arr['lastTradedPrice']
+  end
+  
+  def up_or_down
+    @arr['indicator'] == "U" ? 'up' : 'down'
+  end
+  
+  def to_hash
+    { 
+      symbol: @arr['securitySymbol'],
+      alias: @arr['securityAlias'],
+      total_volume: get_total_volume,
+      updown: up_or_down,
+      percent_change: get_percent_change,
+      last_price: get_last_price
+    }
+  end
+end

data/lib/psei/index.rb

@@ -0,0 +1,55 @@
+class Psei::Index
+  
+  def initialize(parser=nil)
+    @parser = parser || Psei::Parser.new(Psei::SOURCE_URL)
+    @parsed = @parser.process
+    @formatter = Psei::Formatter.new
+  end
+  
+  def symbols
+    indices_hash.keys
+  end
+  
+  # Returns a Hash of last values of indices
+  def values
+    symbols.collect{ |x| value x }
+  end
+  
+  # Returns the last value of an index
+  def value symbol
+    index symbol
+  end
+  
+  def date
+    Psei::Date.new(@parsed).get
+  end
+  
+  private
+  
+  def find_by_symbol symbol
+    indices = indices_filter
+    indices.detect{ |s| s['securitySymbol'] == symbol.to_s }
+  end
+  
+  def indices_filter
+    @ind_filter ||= @parsed.select do |x| 
+      (Psei::INDEX_ALIASES).include?(x['securityAlias']) && x['securitySymbol'] != Psei::HEADING_ALIAS
+    end
+  end
+  
+  def indices_hash
+    @ind_hash ||= Hash[indices_array]
+  end
+  
+  def indices_array
+    @ind_array ||= indices_filter.collect do |item| 
+      [item['securitySymbol'], item['lastTradedPrice'].to_f]
+    end
+  end
+  
+  def index sym
+    ind = indices_filter.select{|x| x['securitySymbol'] == sym }.first
+    @formatter.process ind
+  end
+  
+end

data/lib/psei/parser.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+require 'json'
+
+class Psei::Parser
+  attr_reader :url
+  
+  def initialize url
+    @url = url
+  end
+  
+  def process(response=nil)
+    resp = response || get_response
+    JSON.parse(resp)
+  end
+  
+  private
+  
+  def get_response
+    uri = URI(@url)
+    @response ||= Net::HTTP.get(uri)
+  end
+  
+end

data/lib/psei/security.rb

@@ -0,0 +1,54 @@
+class Psei::Security
+  
+  def initialize(parser=nil)
+    @parser = parser || Psei::Parser.new(Psei::SOURCE_URL)
+    @parsed = @parser.process
+    @formatter = Psei::Formatter.new
+  end
+  
+  def symbols
+    securities_hash.keys
+  end
+  
+  def values
+    symbols.collect{ |x| value x }
+  end
+  
+  # Returns the data of a  specific security
+  def value symbol
+    security symbol
+  end
+  
+  def date
+    Psei::Date.new(@parsed).get
+  end
+  
+  private
+  
+  def find_by_symbol symbol
+    securities = securities_filter
+    securities.detect{ |s| s['securitySymbol'] == symbol.to_s }
+  end
+  
+  def securities_filter
+    @sec_filter ||= @parsed.reject do |x| 
+      (Psei::INDEX_ALIASES).include?(x['securityAlias']) || x['securitySymbol'] == Psei::HEADING_ALIAS
+    end
+  end
+  
+  def securities_hash
+    @sec_hash ||= Hash[securities_array]
+  end
+  
+  def securities_array
+    @sec_array ||= securities_filter.collect do |item| 
+      [item['securitySymbol'], item['lastTradedPrice'].to_f]
+    end
+  end
+  
+  def security sym
+    sec = securities_filter.select{|x| x['securitySymbol'] == sym }.first
+    @formatter.process sec
+  end
+  
+end

data/lib/psei/version.rb

@@ -0,0 +1,3 @@
+module Psei
+  VERSION = "0.1.0"
+end

data/psei.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'psei/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "psei"
+  spec.version       = Psei::VERSION
+  spec.authors       = ["Marvin Baltazar"]
+  spec.email         = ["marvin.baltazar@gmail.com"]
+
+  spec.summary       = %q{Fetch the PSE end-of-day values}
+  spec.description   = %q{This returns the end-of-day values of the Philippine Stock Exchange}
+  spec.homepage      = "https://github.com/marvs/psei"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", '~> 5'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: psei
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marvin Baltazar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: This returns the end-of-day values of the Philippine Stock Exchange
+email:
+- marvin.baltazar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/psei.rb
+- lib/psei/date.rb
+- lib/psei/formatter.rb
+- lib/psei/index.rb
+- lib/psei/parser.rb
+- lib/psei/security.rb
+- lib/psei/version.rb
+- psei.gemspec
+homepage: https://github.com/marvs/psei
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Fetch the PSE end-of-day values
+test_files: []