simplywallst_snowflake 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTlkYjFkMjQ5MmVjYTlkMThiNjU0NjA4NjMyMjJkOWNkZDRmMmU5MA==
+  data.tar.gz: !binary |-
+    NzQ5ZDdjMDA0N2IxMjBlZGUyZmJkY2NhNmY0OGJkMmRkMGNjMmY3YQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZGIyM2U0ZDViZTllYjQwZGFiYjA3NGNiNjUzMzU0NjRhMzVmYTAwMmRkODc1
+    YzQyOTcyNjNhZmM2N2U1NjMzMmJlOWVhOTdmYTY0N2U0ODU5MmExOTYxNGM4
+    ZDYwZmI1N2Y1NGU4Mzc2ZGQwNTQxMGI5MjMxYjBiYWQ1Nzg2OTU=
+  data.tar.gz: !binary |-
+    MzNiMjg4OWFmNTI2ZDQzNDRmYmFkOWU1YzMzNmQ0YzJkYTAzMTM3MGVkOGE5
+    MzM0MTFmNzhkY2Y2OWJmNjBmZTdiZmU1NzU2MWUwNzVjNjVmM2FlMDMzNTA5
+    OTY0YjZkODA5NDdhMjg4Mzk0YjgzNzRkNzUyYjM4MWZlY2NiZTU=

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Code coverage report generated files:
+/coverage/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,8 @@
+#
+# Copyright (c) 2017 Brendan Coles <bcoles@gmail.com>
+# SimplywallstSnowflake - https://github.com/bcoles/simplywallst_snowflake
+# See the file 'LICENSE.txt' for copying permission
+#
+
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    simplywallst_snowflake (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplywallst_snowflake!
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Brendan Coles <bcoles@gmail.com>
+
+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,61 @@
+# SimplyWallSt Snowflake API Client
+
+An unofficial client for [Simply Wall St Snowflake API](https://simplywall.st/api/about).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplywallst_snowflake'
+```
+
+## Usage
+
+Create a new `SimplywallstSnowflake::Client` object with the desired exchange and stock ticker.
+
+```ruby
+require 'simplywallst_snowflake'
+client = SimplywallstSnowflake::Client.new(exchange, ticker)
+```
+
+For example:
+
+```ruby
+client = SimplywallstSnowflake::Client.new('ASX', 'TLS')
+```
+
+The following `client` properties are available:
+
+```
+  response
+  url
+  company_name
+  unique_symbol
+  primary_exchange_symbol
+  primary_ticker_symbol
+  snowflake_scores
+  snowflake_colour
+  widget_url
+  snowflake_tile_url
+  value
+  future
+  past
+  health
+  income
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bcoles/simplywallst_snowflake.
+
+
+## Documentation
+
+SimplyWall.St [Snowflake Widget API Documentation](https://simplywall.st/api/about)
+
+
+## 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,12 @@
+#
+# Copyright (c) 2017 Brendan Coles <bcoles@gmail.com>
+# SimplywallstSnowflake - https://github.com/bcoles/simplywallst_snowflake
+# See the file 'LICENSE.txt' for copying permission
+#
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+#
+# Copyright (c) 2017 Brendan Coles <bcoles@gmail.com>
+# SimplywallstSnowflake - https://github.com/bcoles/simplywallst_snowflake
+# See the file 'LICENSE.txt' for copying permission
+#
+
+require "bundler/setup"
+require "simplywallst_snowflake"
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) 2017 Brendan Coles <bcoles@gmail.com>
+# SimplywallstSnowflake - https://github.com/bcoles/simplywallst_snowflake
+# See the file 'LICENSE.txt' for copying permission
+#
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/simplywallst_snowflake.rb

@@ -0,0 +1,83 @@
+# coding: utf-8
+#
+# Copyright (c) 2017 Brendan Coles <bcoles@gmail.com>
+# SimplywallstSnowflake - https://github.com/bcoles/simplywallst_snowflake
+# See the file 'LICENSE.txt' for copying permission
+#
+
+require 'simplywallst_snowflake/version'
+require 'net/http'
+require 'json'
+
+module SimplywallstSnowflake
+  class Client
+    attr_reader :response
+    attr_reader :url
+
+    attr_reader :company_name
+    attr_reader :unique_symbol
+    attr_reader :primary_exchange_symbol
+    attr_reader :primary_ticker_symbol
+    attr_reader :snowflake_scores
+    attr_reader :snowflake_colour
+    attr_reader :widget_url
+    attr_reader :snowflake_tile_url
+
+    attr_reader :value
+    attr_reader :future
+    attr_reader :past
+    attr_reader :health
+    attr_reader :income
+
+    def initialize(exchange, ticker)
+      raise "Error - Invalid exchange: '#{exchange}'" unless exchange =~ /\A[a-zA-Z0-9]+\z/
+      raise "Error - Invalid ticker: '#{ticker}'" unless ticker =~ /\A[a-zA-Z0-9]+\z/
+
+      @url = URI("https://simplywall.st/api/snowflake/#{exchange}:#{ticker}")
+
+      begin
+        response = Net::HTTP.get(@url)
+      rescue => e
+        raise "Error - Could not connect to SimplyWall.St: #{e.message}"
+      end
+
+      if response.nil? || response.to_s.eql?('') || response.to_s.eql?('{}')
+        raise 'Error - No response from SimplyWall.St'
+      end
+
+      @response = JSON.parse(response)
+
+      unless @response['message'].nil?
+        raise "Error - Could not retrieve snowflake: #{@response['message']}"
+      end
+
+      # Shortened company name
+      @company_name            = @response['companyName']
+      # Unique joined symbol for the company
+      @unique_symbol           = @response['uniqueSymbol']
+      # Primary exchange symbol
+      @primary_exchange_symbol = @response['primaryExchangeSymbol']
+      # Primary ticker symbol
+      @primary_ticker_symbol   = @response['primaryTickerSymbol']
+      # Array of scores for each axis of the snowflake [ Value, Future, Past, Health, Income ]
+      @snowflake_scores        = @response['snowflakeScores']
+      # Scaled float used in colouring the snowflake, range 0.0 (healthy) to 1.0 (bad)
+      @snowflake_colour        = @response['snowflakeColour']
+      # A URL to the snowflake tile as a widget to be used in an iframe
+      @widget_url              = @response['widgetURL']
+      # A URL to a rendered tile of the companies snowflake
+      @snowflake_tile_url      = @response['snowflakeTileURL']
+
+      # Value - value based on future cash flows and its price relative to the stock market 
+      @value  = @snowflake_scores[0]
+      # Future Performance - expected performance in the next 3 years
+      @future = @snowflake_scores[1]
+      # Past Performance - historical performance over the past 5 years
+      @past   = @snowflake_scores[2]
+      # Health - financial health and the level of debt
+      @health = @snowflake_scores[3]
+      # Income - the current dividend yield, its volatility and sustainability 
+      @income = @snowflake_scores[4]
+    end
+  end
+end

data/lib/simplywallst_snowflake/version.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+#
+# Copyright (c) 2017 Brendan Coles <bcoles@gmail.com>
+# SimplywallstSnowflake - https://github.com/bcoles/simplywallst_snowflake
+# See the file 'LICENSE.txt' for copying permission
+#
+
+module SimplywallstSnowflake
+  # Gem version
+  VERSION = '0.1.0'.freeze
+end

data/simplywallst_snowflake.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplywallst_snowflake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplywallst_snowflake"
+  spec.version       = SimplywallstSnowflake::VERSION
+  spec.authors       = ['Brendan Coles']
+  spec.email         = ['bcoles@gmail.com']
+
+  spec.summary       = %q{An unofficial client for Simply Wall St Snowflake API.}
+  spec.homepage      = 'https://github.com/bcoles/simplywallst_snowflake'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: simplywallst_snowflake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brendan Coles
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- bcoles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simplywallst_snowflake.rb
+- lib/simplywallst_snowflake/version.rb
+- simplywallst_snowflake.gemspec
+homepage: https://github.com/bcoles/simplywallst_snowflake
+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.2.2
+signing_key: 
+specification_version: 4
+summary: An unofficial client for Simply Wall St Snowflake API.
+test_files: []
+has_rdoc: