apple_system_status 0.1.0.beta2 → 0.1.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cec83e535718f501b5e3bf6c060dd37192602928
-  data.tar.gz: 8fd5d5181088475c848f544a94700846faad5b79
+  metadata.gz: ae7c1bc4d64eafd171c4df528eb028503d0bbcb0
+  data.tar.gz: e698795a06cc3d33a780127d3b7694237d590d7f
 SHA512:
-  metadata.gz: ef57e3d11fe603cffb80ecedadd4ee80a8c89513e5e92baa040c3465072a8d4785da3976278134970194747aa8b6b7b4779dbdcc186ffc14f4dcffefe429f69b
-  data.tar.gz: 49644aac9a4f59599fac69ada461b586cd01e42634806783df4fe72500e9c514f8924890bd5582345323f94fa2c0e9d3ad7039a787179191e0134ab04a542e4b
+  metadata.gz: 974279679d2a8f7c5d4d007bd30bbde61e004228ceda0d2e96c21eecf94a2110e3a7612aee4fef8a76a5b678333383dc851cf8aeb8f14e81f2c2a9ae29aeab3c
+  data.tar.gz: 4bf9c7f3215565003d2f2b5394a6002c08985fb8327fd8d5f7461a234d754fea921532b3fc83467584e497013f64df6c88635a74d4b46caa91bf5d34fc0ef2f7

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.0
   - 2.1
   - 2.2
   - ruby-head
@@ -18,7 +17,6 @@ notifications:
     secure: wPazrrt03q4/4YEWTGejm2yB36hROtpeJKSojv4cE1gRQarQceyMZdOZU4gvJ7DP5ehGSikp+PvdhUj8ZGmUoLcaQQu89eCxa5BGf3sofYD2EOZJe33w+di+L++41/cFp6XJ9XRPxbmVjpmPzl28yq2nfzgdI90qhztcswojGyT3Pkj0STB4qu6T+Kmvd5o4vlWUsZlKiv20sAav5/kL86/K4gwakmpyxPYMafG4WcVGbXoHovOlwdHXdml3Ldfuq9IQ35tu0xJ23o6RoPHl38klOgQQj4k7vbtowWmE5UWZFzWkPpH9GDYtS3ML4yCcM7QLj8nEMVWj+QlTsICmKgKfvSpcs9jQtLQEykDS/H43dTu3gyLuGPcbKbR08cXxkOq6lAAuVV7avNkJb5yJV8Nj+1PWksbBbTNwURamjogRTejxX1dTTUsTQITrrCJyKCOM8LvigKTBmpkEiBR6wDZqZoAx6HXEu0O8G9XpT7aI3pJ85/RCxQdYDe193olcg25TQNjlrSaFl6M1VCMB3jzNcCHZkmiM9KnTRjTMSn/5FUxzAnGeaHvxff6wMffcPKS3E/j+2sXkdpsL1Kwtj6b7ejpL/Pbn6P926iWx8mUmH0xC04M8nQgDE1aorMuqHSSH0EPUUMGBdOPvXOjR2CEtEYgqH/ymDPsT/dUub1M=
 matrix:
   allow_failures:
-  - rvm: 2.0
   - rvm: ruby-head
 sudo: false
 cache: bundler

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--no-private

data/README.md

@@ -1,8 +1,6 @@
 # AppleSystemStatus
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apple_system_status`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[Apple System Status](https://www.apple.com/support/systemstatus/) scraping library
 
 [![Build Status](https://travis-ci.org/sue445/apple_system_status.svg?branch=master)](https://travis-ci.org/sue445/apple_system_status)
 [![Code Climate](https://codeclimate.com/github/sue445/apple_system_status/badges/gpa.svg)](https://codeclimate.com/github/sue445/apple_system_status)
@@ -10,6 +8,10 @@ TODO: Delete this and the text above, and describe your gem
 [![Coverage Status](https://coveralls.io/repos/sue445/apple_system_status/badge.svg?branch=master&service=github)](https://coveralls.io/github/sue445/apple_system_status?branch=master)
 [![Dependency Status](https://gemnasium.com/sue445/apple_system_status.svg)](https://gemnasium.com/sue445/apple_system_status)
 
+## Requirements
+* Ruby 2.1+
+* [Phantomjs](http://phantomjs.org/)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,9 +28,59 @@ Or install it yourself as:
 
     $ gem install apple_system_status
 
-## Usage
+## Usage (via. ruby)
+```ruby
+crawler = AppleSystemStatus::Crawler.new
+
+# English
+pp crawler.perform
+
+{:title=>"System Status as of 12:51 AM JST",
+ :services=>
+  [{:title=>"App Store",
+    :description=>"No Issues: App Store",
+    :status=>"allgood"},
+   {:title=>"iCloud Account & Sign In",
+    :description=>"No Issues: iCloud Account & Sign In",
+    :status=>"allgood"},
+   # ...
+]}
+
+# Japanese
+pp crawler.perform("jp")
+
+{:title=>"00:53 JST 時点のシステム状況",
+ :services=>
+  [{:title=>"App Store", :description=>"問題なし: App Store", :status=>"allgood"},
+   {:title=>"iCloud ストレージアップグレード",
+    :description=>"問題なし: iCloud ストレージアップグレード",
+    :status=>"allgood"},
+   {:title=>"iTunes Store",
+    :description=>"問題なし: iTunes Store",
+    :status=>"allgood"},
+   # ...
+]}
+```
 
-TODO: Write usage instructions here
+## Usage (via. shell)
+```sh
+$ apple_system_status help
+Commands:
+  apple_system_status fetch           # Fetch apple system status
+  apple_system_status help [COMMAND]  # Describe available commands or one specific command
+  apple_system_status version         # Show apple_system_status version
+
+$ apple_system_status help fetch
+Usage:
+  apple_system_status fetch
+
+Options:
+  [--country=COUNTRY]  # country code. (ex. jp, ca, fr)
+                       # Default: us
+  [--title=TITLE]      # If specified, narrow the service title
+  [--format=FORMAT]    # output format. (ex. plain, json)
+                       # Default: plain
+```
 
 ## Development
 
@@ -38,7 +90,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apple_system_status.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/apple_system_status.
 
 
 ## License

data/apple_system_status.gemspec

@@ -27,15 +27,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
   spec.add_dependency "capybara"
   spec.add_dependency "poltergeist"
   spec.add_dependency "thor"
 
-  spec.add_development_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-parameterized"
+  spec.add_development_dependency "yard"
 end

data/lib/apple_system_status.rb

@@ -6,8 +6,8 @@ module AppleSystemStatus
     case format
     when "plain"
       str = "#{hash[:title]}\n"
-      hash[:statuses].each do |status|
-        str << "#{status[:title]},#{status[:status]},#{status[:description]}\n"
+      hash[:services].each do |service|
+        str << "#{service[:title]},#{service[:status]},#{service[:description]}\n"
       end
       str
 

data/lib/apple_system_status/cli.rb

@@ -4,10 +4,14 @@ require "apple_system_status"
 module AppleSystemStatus
   class CLI < Thor
     desc "fetch", "Fetch apple system status"
-    option :country, desc: "country code. (ex. jp, ca, fr)"
-    option :format, desc: "output format. (ex. plain, json)", default: "plain"
+    option :country, desc: "country code. (ex. jp, ca, fr)", default: "us"
+    option :title,   desc: "If specified, narrow the service title"
+    option :format,  desc: "output format. (ex. plain, json)", default: "plain"
     def fetch
-      response = AppleSystemStatus::Crawler.new.perform(options[:country])
+      response = AppleSystemStatus::Crawler.new.perform(
+        country: options[:country],
+        title:   options[:title],
+      )
       puts AppleSystemStatus.format_response(response, options[:format])
     end
 

data/lib/apple_system_status/crawler.rb

@@ -1,6 +1,7 @@
 module AppleSystemStatus
   require "capybara"
   require 'capybara/poltergeist'
+  require "active_support/core_ext/object/blank"
 
   class Crawler
     USER_AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.134 Safari/537.36"
@@ -13,7 +14,18 @@ module AppleSystemStatus
       @session.driver.headers = { "User-Agent" => USER_AGENT }
     end
 
-    def perform(country = nil)
+    # crawl apple system status page
+    # @param country [String] country code. (ex. jp, ca, fr. default. us)
+    # @param title   [String] If specified, narrow the service title
+    # @return [Hash]
+    # @example response format
+    #   {
+    #     title: ,
+    #     services: [
+    #       { title: , description: , status:  }
+    #     ]
+    #   }
+    def perform(country: nil, title: nil)
       @session.visit(apple_url(country))
 
       title_parts = [
@@ -24,12 +36,12 @@ module AppleSystemStatus
 
       response = {
         title:    title_parts.join(" ").strip,
-        statuses: [],
+        services: [],
       }
 
-      @session.all("#dashboard td").each_with_object(response[:statuses]) do |td, statuses|
+      @session.all("#dashboard td").each_with_object(response[:services]) do |td, services|
         begin
-          statuses << {
+          services << {
             title:       td.find("p[role='text']").text,
             description: td.find("p[role='text']")["aria-label"],
             status:      td.find("span")["class"],
@@ -39,16 +51,20 @@ module AppleSystemStatus
         end
       end
 
+      unless title.blank?
+        response[:services].select! { |service| service[:title] == title }
+      end
+
+      response[:services].sort_by! { |service| service[:title] }
+
       response
     end
 
-    private
-
     def apple_url(country)
-      if country
-        "https://www.apple.com/#{country}/support/systemstatus/"
-      else
+      if country.blank? || country == "us"
         "https://www.apple.com/support/systemstatus/"
+      else
+        "https://www.apple.com/#{country}/support/systemstatus/"
       end
     end
   end

data/lib/apple_system_status/version.rb

@@ -1,3 +1,3 @@
 module AppleSystemStatus
-  VERSION = "0.1.0.beta2"
+  VERSION = "0.1.0.beta3"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: apple_system_status
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta2
+  version: 0.1.0.beta3
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-25 00:00:00.000000000 Z
+date: 2015-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: poltergeist
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -150,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-parameterized
+  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: yard
+  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: Apple System Status scraping library
 email:
 - sue445@sue445.net
@@ -162,6 +190,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -200,3 +229,4 @@ signing_key:
 specification_version: 4
 summary: Apple System Status scraping library
 test_files: []
+has_rdoc: