trend 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a0e816457dabd59905b38ec854e53a3bb565e0a55d76ce87ac0d191a3134a9a
-  data.tar.gz: ceefde2ec29a66596f995e5a9a4c8847d5c839a37e4c0fa84a835eba035ee3df
+  metadata.gz: a83763d819e0962a0c4c7ca0cb0f5af76852be87becd30bbd341b12246a7510b
+  data.tar.gz: ed4b4e58dc20df46dfdb7d252f4dcf680494bb38b901301c002a5a309f840344
 SHA512:
-  metadata.gz: 383959b7c7ba1331b3f4f5607825e410cf74ef047bf299a3e98fbc0c24bf003e2a9753103ea438b65b1a22d8cf4f6274a55dba2aa87b25ed5a28d041456f3ae0
-  data.tar.gz: a4c1bf226d83f76f4a1d4bffb431276b1f9a1fda548d05301efd1053dab8a724fe8bdd069f766e0d2d9cdc06a45dd9fe5936e6b258b8fd57d8e481ce05edb714
+  metadata.gz: 042cd0604e706892b96009608827b6ec4cc14336d20d15779de0f6c0bb05bace81b16691d1c78168449041efe1a308c4fccc46ac9ef7b8ff98a44f4ecaa948b6
+  data.tar.gz: dd854dc3931e03260eb236fe7d40f7f3da2cb830676472e0d5a9d48c568274e0dae40b47b208cba31dba70e45e2bf503e353eb746283162eca6d3ebeaf566f6c

data/.travis.yml

@@ -0,0 +1,11 @@
+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/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.1
+
+- Added support for API keys
+- Added experimental `correlation` method
+
 ## 0.1.0
 
 - First release

data/README.md

@@ -1,6 +1,8 @@
 # Trend
 
-Ruby client for [Trend](https://trendapi.org), the time series API
+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)
 
 ## Getting Started
 
@@ -10,7 +12,7 @@ Add this line to your application’s Gemfile:
 gem 'trend'
 ```
 
-### Anomalies
+### Anomaly Detection
 
 Detect anomalies in a time series
 
@@ -36,7 +38,7 @@ series = User.group_by_day(:created_at).count
 Trend.anomalies(series)
 ```
 
-### Forecast
+### Forecasting
 
 Get future predictions for a time series
 
@@ -64,6 +66,24 @@ Specify the number of predictions to return
 Trend.forecast(series, count: 3)
 ```
 
+### Correlation [experimental]
+
+Get the correlation between two time series
+
+```ruby
+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)

data/lib/trend/client.rb

@@ -1,13 +1,16 @@
+require "trend/version"
+
 module Trend
   class Client
     HEADERS = {
       "Content-Type" => "application/json",
-      "Accept" => "application/json"
+      "Accept" => "application/json",
+      "User-Agent" => "trend-ruby/#{Trend::VERSION}"
     }
 
-    def initialize(url: nil)
-      url ||= Trend.url
-      @uri = URI.parse(url)
+    def initialize(url: nil, api_key: nil)
+      @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
@@ -24,6 +27,11 @@ module Trend
       Hash[resp["forecast"].map { |k, v| [parse_time(k), v] }]
     end
 
+    def correlation(series, series2, params = {})
+      resp = make_request("correlation", series, params.merge(series2: series2))
+      resp["correlation"]
+    end
+
     private
 
     def make_request(path, series, params)
@@ -31,6 +39,8 @@ module Trend
         series: series
       }.merge(params)
 
+      path = "#{path}?#{URI.encode_www_form(api_key: @api_key)}" if @api_key
+
       begin
         response = @http.post("/#{path}", post_data.to_json, HEADERS)
       rescue Errno::ECONNREFUSED, Timeout::Error => e

data/lib/trend/version.rb

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

data/lib/trend.rb

@@ -17,6 +17,10 @@ module Trend
     client.forecast(*args)
   end
 
+  def self.correlation(*args)
+    client.correlation(*args)
+  end
+
   def self.url
     @url ||= ENV["TREND_URL"] || "https://trendapi.org"
   end
@@ -26,6 +30,15 @@ module Trend
     @client = nil
   end
 
+  def self.api_key
+    @api_key ||= ENV["TREND_API_KEY"]
+  end
+
+  def self.api_key=(api_key)
+    @api_key = api_key
+    @client = nil
+  end
+
   # private
   def self.client
     @client ||= Client.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trend
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby client for Trend, the time series API