updown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2dbae809fc3ca16f30af62279401f4310eda7db
-  data.tar.gz: 2f582ea04640723eac849cb8d5647c2d1d27a4e8
+  metadata.gz: cd938c29ae89b14996a0c327baa66cf3bdfdade3
+  data.tar.gz: ebdefb7d0cefab8592785555cafce000d956d1ad
 SHA512:
-  metadata.gz: 9712a39c483a6dd62d10889519b436e3013218e5a57427ac2e80224113dbf3c75aea9083ff2be3b25fdcaf67d8f214daba49fc6e2bd09703b13272b6e5eb7cd0
-  data.tar.gz: 7167145967a7e8b56104fd312badd76ed0f72ed91bca1685d05e2b0827817398f7a9262f33e07c57bf42e0cfea5bb10ad6ad4dfda326507cf2c9ba746bc1b812
+  metadata.gz: c07ae3f8c77b886a00b0a29d7a8eb0403d7a8f229de9af85b5ad5edbd52128796bf355016ac8a8418dfe90540405250c75237f532c57aa77e496135abf049933
+  data.tar.gz: eafc6788479953c7043341daccd8b368f220f5705c706d2bdc4010c200a226d2749a6c42042c2286ef7d7829a82a3f6baf5cc4f6fc3a3eaea99ebcfec056912a

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg
+tmp

data/README.md

@@ -1,6 +1,6 @@
 # Updown
 
-A wrapper for the Updown.io API
+A Ruby wrapper and CLI for the [updown.io](https://updown.io) API
 
 ## Installation
 
@@ -10,15 +10,10 @@ Add this line to your application's Gemfile:
 gem 'updown'
 ```
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install updown
 
-
 ## Configuration
 
 Set your API key
@@ -34,75 +29,85 @@ Updown.configuration.api_key = 'your_api_key'
 
 Or set the `UPDOWN_API_KEY` environment variable
 
+Find your API key in your [settings page](https://updown.io/settings/edit).
+
 ## Usage
 
 List all your checks:
 
 ```ruby
 Updown::Check.all
+# => [<Updown::Check>, <Updown::Check>, … ]
 ```
 
-See downtimes for a specific check:
+List downtimes for a specific check (paginated, 100 per call):
 
 ```ruby
 check.downtimes
+# => [<Updown::Downtime>, <Updown::Downtime>, … ]
+
+check.downtimes page: 2
+# => [<Updown::Downtime>]
 ```
 
 Create a new check:
 
 ```ruby
 Updown::Check.create 'https://google.com'
+# => <Updown::Check>
 ```
 
-You can also set `period` and `published`:
+You can also set any parameters allowed by the API, like `enabled`, `published`, `period` or `apdex_t`:
 
 ```ruby
 Updown::Check.create 'https://google.com', period: 30, published: true
+# => <Updown::Check>
+```
+
+In case of validation errors, an `Updown::Error` will be raised:
+
+```ruby
+Updown::Check.create 'https://google.com', period: 45
+# => Updown::Error: URL is already registered (given: "https://google.com"), Period is not included in the list (given: 45)
 ```
 
 Update a specific check:
 
 ```ruby
 check.update period: 30
+# => <Updown::Check>
 ```
 
-See more details about the options here: https://updown.io/api
-
 Delete a specific check:
 
 ```ruby
 check.destroy
+# => true
 ```
 
-## Command Line
+Learn more about the API here: https://updown.io/api
 
-This gem also comes with a few commands
+## Command Line
 
+This gem also comes with an `updown` shell command.
 First, configure your API key:
 
-```
-$ updown configure YOUR_API_KEY
-```
+    $ updown configure YOUR_API_KEY
 
 See the status of your checks:
 
-```
-$ updown status
-[up] https://google.com
-[up] https://bing.com
-```
+    $ updown status
+     [up]  rjis — https://google.com
+    [DOWN] bn94 — https://bing.com
+     [up]  qwer — http://stackoverflow.com
 
 Add a new check:
 
-```
-$ updown add https://google.com
-```
-
+    $ updown add https://google.com
 
 ## Todo
 
 - Write tests!
-- Error handling
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
-require 'bundler/gem_tasks'
+require 'bundler/gem_tasks'
+
+desc "Open an irb session preloaded with updown gem"
+task :console do
+  sh "irb -rubygems -I lib -r updown.rb"
+end

data/lib/updown/call.rb

@@ -1,28 +1,39 @@
+require 'json'
+
 module Updown
-  class Call
+  Error = Class.new StandardError
+
+  module Call
 
     def self.resource
       RestClient::Resource.new 'https://updown.io/api/', headers: { 'X-API-KEY' => Updown.configuration.api_key }
     end
 
     def self.checks
-      JSON.parse Call.resource['checks'].get
+      process { Call.resource['checks'].get }
     end
 
-    def self.downtimes(token)
-      JSON.parse Call.resource["checks/#{token}/downtimes"].get
+    def self.downtimes(token, filters={})
+      process { Call.resource["checks/#{token}/downtimes"].get(params: filters) }
     end
 
     def self.create_check(attributes={})
-      JSON.parse Call.resource['checks'].post(attributes)
+      process { Call.resource['checks'].post(attributes) }
     end
 
     def self.update_check(token, attributes={})
-      JSON.parse Call.resource["checks/#{token}"].put(attributes)
+      process { Call.resource["checks/#{token}"].put(attributes) }
     end
 
     def self.destroy_check(token)
-      JSON.parse Call.resource["checks/#{token}"].delete
+      process { Call.resource["checks/#{token}"].delete }
+    end
+
+    def self.process
+      JSON.parse yield
+    rescue RestClient::BadRequest, RestClient::Unauthorized, RestClient::ResourceNotFound => e
+      result = (JSON.parse(e.response) rescue {})
+      raise Updown::Error.new(result['error'] || e.reponse)
     end
 
   end

data/lib/updown/check.rb

@@ -1,6 +1,6 @@
 module Updown
   class Check
-    attr_accessor :token, :enabled, :url, :period, :apdex_t, :published, :uptime, :down, :error, :down_since, :last_check_at, :next_check_at
+    attr_accessor :token, :url, :last_status, :uptime, :down, :down_since, :error, :period, :apdex_t, :enabled, :published, :last_check_at, :next_check_at, :ssl_tested_at, :ssl_valid, :ssl_error
 
     def self.all
       Updown::Call.checks.map do |check|
@@ -8,36 +8,41 @@ module Updown
       end
     end
 
-    def self.create(url, period: 60, published: false)
-      Check.new Updown::Call.create_check(url: url, period: period, published: published)
+    def self.create(url, attributes = {})
+      Check.new Updown::Call.create_check(attributes.merge(url: url))
     end
 
     def initialize(json)
       @token         = json['token']
-      @enabled       = json['enabled']
       @url           = json['url']
+      @last_status   = json['last_status']
+      @enabled       = json['enabled']
       @period        = json['period']
       @apdex_t       = json['apdex_t']
       @published     = json['published']
       @uptime        = json['uptime']
       @down          = json['down']
       @error         = json['error']
-      @down_since    = json['down_since']
-      @last_check_at = json['last_check_at']
-      @next_check_at = json['next_check_at']
+      @down_since    = Time.parse(json['down_since']) if json['down_since']
+      @last_check_at = Time.parse(json['last_check_at']) if json['last_check_at']
+      @next_check_at = Time.parse(json['next_check_at']) if json['next_check_at']
+      if ssl = json['ssl']
+        @ssl_tested_at = Time.parse(ssl['tested_at']) if ssl['tested_at']
+        @ssl_valid     = ssl['valid']
+        @ssl_error     = ssl['error']
+      end
     end
 
-    def downtimes
-      Downtime.find(@token)
+    def downtimes page: 1
+      Downtime.find(@token, page: page)
     end
 
     def update(attributes={})
-      Check.new Updown::Call.update_check(@token, url: url, period: period, published: published)
+      Check.new Updown::Call.update_check(@token, attributes)
     end
 
     def destroy
-      Updown::Call.destroy_check(@token)
-      nil
+      Updown::Call.destroy_check(@token)['deleted']
     end
   end
 end

data/lib/updown/cli.rb

@@ -1,3 +1,7 @@
+require 'colorize'
+
+String.disable_colorization(true) if not STDOUT.isatty
+
 module Updown
   class CLI < Thor
 
@@ -6,9 +10,24 @@ module Updown
       configure_api_key
 
       Updown::Check.all.each do |check|
-        status = check.down ? 'DOWN' : 'up'
-        puts "[#{status}] #{check.url}"
+        status = if !check.enabled
+          ' ---- '.colorize(:light_black)
+        elsif check.down
+          '[DOWN]'.colorize(:light_red)
+        else
+          ' [up] '.colorize(:light_green)
+        end
+        url = if check.ssl_valid == true
+          check.url.sub('https', 'https'.colorize(:light_green))
+        elsif check.ssl_valid == false
+          check.url.sub('https', 'https'.colorize(:light_red))
+        else
+          check.url
+        end
+        puts "#{status} #{check.token.colorize(:light_magenta)} #{"—".colorize(:light_black)} #{url}"
       end
+    rescue Updown::Error => e
+      puts "Error: #{e}"
     end
 
     desc 'add URL [PERIOD]', 'add a new check'
@@ -17,6 +36,8 @@ module Updown
 
       check = Updown::Check.create url, period: period
       system "open https://updown.io/#{check.token}"
+    rescue Updown::Error => e
+      puts "Error: #{e}"
     end
 
     desc 'configure API_KEY', 'set your updown.io api key'

data/lib/updown/downtime.rb

@@ -2,16 +2,16 @@ module Updown
   class Downtime
     attr_accessor :error, :started_at, :ended_at, :duration
 
-    def self.find(token)
-      Updown::Call.downtimes(token).map do |downtime|
+    def self.find(token, page: 1)
+      Updown::Call.downtimes(token, page: page).map do |downtime|
         Downtime.new downtime
       end
     end
 
     def initialize(json)
       @error      = json['error']
-      @started_at = json['started_at']
-      @ended_at   = json['ended_at']
+      @started_at = Time.parse(json['started_at']) if json['started_at']
+      @ended_at   = Time.parse(json['ended_at']) if json['ended_at']
       @duration   = json['duration']
     end
 

data/lib/updown/version.rb

@@ -1,3 +1,3 @@
 module Updown
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/updown.rb

@@ -11,5 +11,5 @@ module Updown
   with_configuration do
     has :api_key, classes: String, default: ENV['UPDOWN_API_KEY'].to_s
   end
-  
+
 end

data/updown.gemspec

@@ -6,10 +6,10 @@ require 'updown/version'
 Gem::Specification.new do |spec|
   spec.name          = "updown"
   spec.version       = Updown::VERSION
-  spec.authors       = ["Aske Hansen"]
-  spec.email         = ["aske@deeco.dk"]
-  spec.summary       = %q{Updown.io wrapper}
-  spec.description   = %q{A wrapper for the Updown.io API}
+  spec.authors       = ["Aske Hansen", "Adrien Jarthon"]
+  spec.email         = ["aske@deeco.dk", "me@adrienjarthon.com"]
+  spec.summary       = %q{updown.io API wrapper}
+  spec.description   = %q{A wrapper for the updown.io API}
   spec.homepage      = "https://github.com/askehansen/updown-ruby"
   spec.license       = "MIT"
 
@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rest-client'
   spec.add_dependency 'thor'
-
-  spec.add_runtime_dependency 'gem_config'
+  spec.add_dependency 'gem_config'
+  spec.add_dependency 'colorize'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: updown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aske Hansen
+- Adrien Jarthon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,16 +81,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A wrapper for the Updown.io API
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper for the updown.io API
 email:
 - aske@deeco.dk
+- me@adrienjarthon.com
 executables:
 - updown
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -121,8 +137,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Updown.io wrapper
+summary: updown.io API wrapper
 test_files: []
+has_rdoc: 

data/Gemfile.lock

@@ -1,27 +0,0 @@
-PATH
-  remote: .
-  specs:
-    updown (0.1.0)
-      gem_config
-      rest-client
-      thor
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    gem_config (0.3.1)
-    mime-types (2.4.3)
-    netrc (0.10.3)
-    rake (10.4.2)
-    rest-client (1.7.3)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    thor (0.19.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.7)
-  rake (~> 10.0)
-  updown!