trend 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a83763d819e0962a0c4c7ca0cb0f5af76852be87becd30bbd341b12246a7510b
-  data.tar.gz: ed4b4e58dc20df46dfdb7d252f4dcf680494bb38b901301c002a5a309f840344
+  metadata.gz: be4aa1b64d52a9185046f567b304af2e75dfada027d6bc971325081b0b741c61
+  data.tar.gz: e5bcc34a35292c55f94d32959a54b7db3ad6ab8a450793bf8ae87a8e17cff9f3
 SHA512:
-  metadata.gz: 042cd0604e706892b96009608827b6ec4cc14336d20d15779de0f6c0bb05bace81b16691d1c78168449041efe1a308c4fccc46ac9ef7b8ff98a44f4ecaa948b6
-  data.tar.gz: dd854dc3931e03260eb236fe7d40f7f3da2cb830676472e0d5a9d48c568274e0dae40b47b208cba31dba70e45e2bf503e353eb746283162eca6d3ebeaf566f6c
+  metadata.gz: c1771a5627ff3f99764f953c243052192d7d461d039553e559fdf49a57e30ec7fc52138e5d5ab37dd670d17916db300573c84045531233e3e64d1c4be3d2f658
+  data.tar.gz: c1618e0b0db4a942f161f6ba4b46de0e1efb64b85699d59bc54d77036dc0e02aff215f0863cfc19c2e1498880e629601d228d019612d38053c2d109fa37cc28d

data/CHANGELOG.md

@@ -1,8 +1,17 @@
-## 0.1.1
+## 0.2.0 (2023-05-03)
+
+- Dropped support for Ruby < 3
+
+## 0.1.2 (2019-04-10)
+
+- Extended timeout
+- Added `timeout` option
+
+## 0.1.1 (2018-10-28)
 
 - Added support for API keys
 - Added experimental `correlation` method
 
-## 0.1.0
+## 0.1.0 (2018-05-23)
 
 - First release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Andrew Kane
+Copyright (c) 2018-2023 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

data/README.md

@@ -1,25 +1,31 @@
-# Trend
+# Trend Ruby
 
 Ruby client for [Trend](https://trendapi.org), the anomaly detection and forecasting API
 
-[![Build Status](https://travis-ci.org/ankane/trend.svg?branch=master)](https://travis-ci.org/ankane/trend)
+[![Build Status](https://github.com/ankane/trend-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/trend-ruby/actions)
 
-## Getting Started
+## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'trend'
+gem "trend"
 ```
 
-### Anomaly Detection
+For the [self-hosted API](https://github.com/ankane/trend-api), create an initializer with:
+
+```ruby
+Trend.url = "http://localhost:8000"
+```
+
+## Anomaly Detection
 
 Detect anomalies in a time series
 
 ```ruby
 # generate series
 series = {}
-date = Date.parse("2018-04-01")
+date = Date.parse("2023-04-01")
 28.times do
   series[date] = rand(100)
   date += 1
@@ -31,20 +37,20 @@ series[date - 8] = 999
 Trend.anomalies(series)
 ```
 
-Works great with libraries like [Groupdate](https://github.com/ankane/groupdate)
+Works great with [Groupdate](https://github.com/ankane/groupdate)
 
 ```ruby
 series = User.group_by_day(:created_at).count
 Trend.anomalies(series)
 ```
 
-### Forecasting
+## Forecasting
 
 Get future predictions for a time series
 
 ```ruby
 series = {}
-date = Date.parse("2018-04-01")
+date = Date.parse("2023-04-01")
 28.times do
   series[date] = date.wday
   date += 1
@@ -66,7 +72,7 @@ Specify the number of predictions to return
 Trend.forecast(series, count: 3)
 ```
 
-### Correlation [experimental]
+## Correlation [experimental]
 
 Get the correlation between two time series
 
@@ -74,34 +80,24 @@ Get the correlation between two time series
 Trend.correlation(series, series2)
 ```
 
-## Authentication
-
-An API key is needed for more than 1000 requests per day per IP. [Email us](mailto:hi@trendapi.org) to get one.
-
-If you have one, set `ENV["TREND_API_KEY"]` or use:
-
-```ruby
-Trend.api_key = "secret"
-```
-
 ## History
 
-View the [changelog](https://github.com/ankane/trend/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/trend-ruby/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)
+- [Report bugs](https://github.com/ankane/trend-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/trend-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
-To get started with development and testing:
+To get started with development:
 
 ```sh
-git clone https://github.com/ankane/trend.git
-cd trend
+git clone https://github.com/ankane/trend-ruby.git
+cd trend-ruby
 bundle install
-rake test
+bundle exec rake test
 ```

data/lib/trend/client.rb

@@ -8,13 +8,13 @@ module Trend
       "User-Agent" => "trend-ruby/#{Trend::VERSION}"
     }
 
-    def initialize(url: nil, api_key: nil)
+    def initialize(url: nil, api_key: nil, timeout: 30)
       @api_key = api_key || Trend.api_key
       @uri = URI.parse(url || Trend.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
+      @http.open_timeout = timeout
+      @http.read_timeout = timeout
     end
 
     def anomalies(series, params = {})

data/lib/trend/version.rb

@@ -1,3 +1,3 @@
 module Trend
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/trend.rb

@@ -1,10 +1,12 @@
+# stdlib
 require "date"
 require "json"
 require "net/http"
 require "time"
 
-require "trend/client"
-require "trend/version"
+# modules
+require_relative "trend/client"
+require_relative "trend/version"
 
 module Trend
   class Error < StandardError; end

metadata

@@ -1,94 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: trend
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2018-10-29 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
+date: 2023-05-03 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - 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
+homepage: https://github.com/ankane/trend-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,16 +34,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Ruby client for Trend, the time series API
 test_files: []

data/.gitignore

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

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm: 2.5.1
-gemfile:
-  - Gemfile
-sudo: false
-before_install: gem install bundler
-script: bundle exec rake test
-notifications:
-  email:
-    on_success: never
-    on_failure: change

data/Gemfile

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

data/Rakefile

@@ -1,29 +0,0 @@
-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/trend.gemspec

@@ -1,29 +0,0 @@
-
-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