trend 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a0e816457dabd59905b38ec854e53a3bb565e0a55d76ce87ac0d191a3134a9a
+  data.tar.gz: ceefde2ec29a66596f995e5a9a4c8847d5c839a37e4c0fa84a835eba035ee3df
+SHA512:
+  metadata.gz: 383959b7c7ba1331b3f4f5607825e410cf74ef047bf299a3e98fbc0c24bf003e2a9753103ea438b65b1a22d8cf4f6274a55dba2aa87b25ed5a28d041456f3ae0
+  data.tar.gz: a4c1bf226d83f76f4a1d4bffb431276b1f9a1fda548d05301efd1053dab8a724fe8bdd069f766e0d2d9cdc06a45dd9fe5936e6b258b8fd57d8e481ce05edb714

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew Kane
+
+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,87 @@
+# Trend
+
+Ruby client for [Trend](https://trendapi.org), the time series API
+
+## Getting Started
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'trend'
+```
+
+### Anomalies
+
+Detect anomalies in a time series
+
+```ruby
+# generate series
+series = {}
+date = Date.parse("2018-04-01")
+28.times do
+  series[date] = rand(100)
+  date += 1
+end
+
+# add an anomaly on Apr 21
+series[date - 8] = 999
+
+Trend.anomalies(series)
+```
+
+Works great with libraries like [Groupdate](https://github.com/ankane/groupdate)
+
+```ruby
+series = User.group_by_day(:created_at).count
+Trend.anomalies(series)
+```
+
+### Forecast
+
+Get future predictions for a time series
+
+```ruby
+series = {}
+date = Date.parse("2018-04-01")
+28.times do
+  series[date] = date.wday
+  date += 1
+end
+
+Trend.forecast(series)
+```
+
+Also works great with Groupdate
+
+```ruby
+series = User.group_by_day(:created_at).count
+Trend.forecast(series)
+```
+
+Specify the number of predictions to return
+
+```ruby
+Trend.forecast(series, count: 3)
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/trend/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/trend/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/trend/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/trend.git
+cd trend
+bundle install
+rake test
+```

data/Rakefile

@@ -0,0 +1,29 @@
+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
+
+task :benchmark do
+  require "benchmark/ips"
+  require "trend"
+
+  series = {}
+  date = Date.parse("2018-01-01")
+  1000.times do
+    series[date] = rand(100)
+    date += 1
+  end
+
+  Trend.url = "http://localhost:8000"
+
+  Benchmark.ips do |x|
+    x.report("anomalies") { Trend.anomalies(series) }
+    x.report("forecast") { Trend.forecast(series) }
+  end
+end

data/lib/trend.rb

@@ -0,0 +1,33 @@
+require "date"
+require "json"
+require "net/http"
+require "time"
+
+require "trend/client"
+require "trend/version"
+
+module Trend
+  class Error < StandardError; end
+
+  def self.anomalies(*args)
+    client.anomalies(*args)
+  end
+
+  def self.forecast(*args)
+    client.forecast(*args)
+  end
+
+  def self.url
+    @url ||= ENV["TREND_URL"] || "https://trendapi.org"
+  end
+
+  def self.url=(url)
+    @url = url
+    @client = nil
+  end
+
+  # private
+  def self.client
+    @client ||= Client.new
+  end
+end

data/lib/trend/client.rb

@@ -0,0 +1,53 @@
+module Trend
+  class Client
+    HEADERS = {
+      "Content-Type" => "application/json",
+      "Accept" => "application/json"
+    }
+
+    def initialize(url: nil)
+      url ||= Trend.url
+      @uri = URI.parse(url)
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = true if @uri.scheme == "https"
+      @http.open_timeout = 3
+      @http.read_timeout = 5
+    end
+
+    def anomalies(series, params = {})
+      resp = make_request("anomalies", series, params)
+      resp["anomalies"].map { |v| parse_time(v) }
+    end
+
+    def forecast(series, params = {})
+      resp = make_request("forecast", series, params)
+      Hash[resp["forecast"].map { |k, v| [parse_time(k), v] }]
+    end
+
+    private
+
+    def make_request(path, series, params)
+      post_data = {
+        series: series
+      }.merge(params)
+
+      begin
+        response = @http.post("/#{path}", post_data.to_json, HEADERS)
+      rescue Errno::ECONNREFUSED, Timeout::Error => e
+        raise Trend::Error, e.message
+      end
+
+      parsed_body = JSON.parse(response.body) rescue {}
+
+      if !response.is_a?(Net::HTTPSuccess)
+        raise Trend::Error, parsed_body["error"] || "Server returned #{response.code} response"
+      end
+
+      parsed_body
+    end
+
+    def parse_time(v)
+      v.size == 10 ? Date.parse(v) : Time.parse(v)
+    end
+  end
+end

data/lib/trend/version.rb

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

data/trend.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "trend/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "trend"
+  spec.version       = Trend::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "Ruby client for Trend, the time series API"
+  spec.homepage      = "https://github.com/ankane/trend"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "benchmark-ips"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: trend
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/trend.rb
+- lib/trend/client.rb
+- lib/trend/version.rb
+- trend.gemspec
+homepage: https://github.com/ankane/trend
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby client for Trend, the time series API
+test_files: []