auntie 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fed4976f396372cbd6c5b4c71ced8a439b06f6a6
-  data.tar.gz: 6713d54954ef44ba9326eb15995c7a7b8788d05b
+  metadata.gz: 2b52477f5f746d84a915062f1e8e753a67699e05
+  data.tar.gz: 52dfbb1a107163110d67c12c131f1ef7109b668c
 SHA512:
-  metadata.gz: f7365a73fb95203fe90a2af2d1533207f118f8a0ce251a6a0f0d2f9e1491f9daba0a77746034833fd4478178b443a8ef9308879c96f507b9480e2ef34861638d
-  data.tar.gz: d02f68b2fb542075f5f1723ae713c42a36964ae49affada31992e947da2c854313caf81366e86aef620d84ab8a6d36cacf8da43dc723ae6305a0e56542653fc6
+  metadata.gz: 623f37227d3a316507bb4f58a99b34563ef643f74f3df3d3b2d37a4c7f8568820c4b3e3ee10e9023e7144b3b5a6cd1d643d96d651e131ad03cc9feb76b653ef4
+  data.tar.gz: 88df1f09a00642f50866efff98076b0413bdcfed27e1a4b1924140ed0a75c936a38f95534fd4b6bf2e0bcb48a6a708d8ad2c757faed538a73f45b2e68a108c5e

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
+group :development, :test do
+  # This is here because gemspec doesn't support require: false
+  gem 'coveralls', :require => false
+end
+
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    auntie (0.2.0)
+    auntie (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -15,19 +15,30 @@ GEM
     builder (3.1.4)
     childprocess (0.2.3)
       ffi (~> 1.0.6)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
     cucumber (1.2.1)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.11.0)
       json (>= 1.4.6)
     diff-lcs (1.1.3)
+    docile (1.1.3)
     ffi (1.0.11)
     gherkin (2.11.5)
       json (>= 1.4.6)
     json (1.7.5)
+    mime-types (2.1)
+    multi_json (1.8.4)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -36,6 +47,15 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.2)
 
 PLATFORMS
   ruby
@@ -44,6 +64,7 @@ DEPENDENCIES
   anticipate
   aruba
   auntie!
+  coveralls
   rake
   rdoc
   rspec

data/README.md

@@ -1,7 +1,10 @@
-# Auntie
-
 [![Build Status](https://travis-ci.org/simongregory/auntie.png?branch=master)](https://travis-ci.org/simongregory/auntie)
+[![Coverage](https://coveralls.io/repos/simongregory/auntie/badge.png?branch=master)](https://coveralls.io/r/simongregory/auntie)
 [![Code Climate](https://codeclimate.com/github/simongregory/auntie.png)](https://codeclimate.com/github/simongregory/auntie)
+[![Dependency Status](https://gemnasium.com/simongregory/auntie.png)](https://gemnasium.com/simongregory/auntie)
+[![Gem Version](https://badge.fury.io/rb/auntie.png)](http://badge.fury.io/rb/auntie)
+
+# Auntie
 
 A Ruby Gem for accessing [BBC]() Weather, TV, Radio, News and Sport feeds.
 
@@ -20,9 +23,9 @@ A Ruby Gem for accessing [BBC]() Weather, TV, Radio, News and Sport feeds.
     radio        # what is on Radio 1 today
     radio next   # what is on the wireless next
     radio six    # what is on Radio Six Music
-    
+
     news         # the latest news headlines
-    
+
     sport        # the latest sport headlines
 
 ## zsh integration

data/bin/auntie

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+SAY_HELLO=<<EOM
+auntie is a collection of tools for accessing BBC Weather, TV, Radio, News and Sport
+
+Useage:
+
+weather      # lists the weather for the next 24 hours
+
+tv           # what is on BBC One today
+tv two       # what is on BBC Two today
+tv now       # list of all programmes being broadcast on tv now
+tv next      # list of all programmes being broadcast on tv next
+
+radio        # what is on Radio 1 today
+radio six    # what is on Radio Six Music
+radio now    # what is on the wireless now
+radio next   # what is on the wireless next
+
+news         # the latest news headlines
+
+sport        # the latest sport headlines
+
+EOM
+
+puts SAY_HELLO

data/bin/news

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require 'auntie'
 
-if ['help', '-h', '--help'].include? ARGV[0]
+if %w(help -h --help).include? ARGV[0]
   puts 'Useage: news'
   exit
 end

data/bin/radio

@@ -2,28 +2,28 @@
 require 'auntie'
 
 channels = {
-  :one => { :id => 'radio1', :region => '/england' },
-  :onextra => { :id => '1xtra' },
-  :two => { :id => 'radio2' },
-  :three => { :id => 'radio3' },
-  :four => { :id => 'radio4', :region => '/fm' },
-  :fourextra => { :id => 'radio4extra' },
-  :five => { :id => '5live' },
-  :six => { :id => '6music' },
-  :asian => { :id => 'asiannetwork' },
-  :worldservice => { :id => 'worldserviceradio' }
+  one: { id: 'radio1', region: '/england' },
+  onextra: { id: '1xtra' },
+  two: { id: 'radio2' },
+  three: { id: 'radio3' },
+  four: { id: 'radio4', region: '/fm' },
+  fourextra: { id: 'radio4extra' },
+  five: { id: '5live' },
+  six: { id: '6music' },
+  asian: { id: 'asiannetwork' },
+  worldservice: { id: 'worldserviceradio' }
 }
 
 channel = ARGV[0] || :one
 
 if ARGV[0] == 'help' && ARGV[1] == '-c'
-  channels.each { |k,v| puts k }
+  channels.each { |k, v| puts k }
   puts "now\nnext"
   exit
 end
 
-if ['help', '-h', '--help'].include? ARGV[0]
-  puts 'Useage: radio <channel>'
+if %w( help -h --help).include? ARGV[0]
+  puts 'Useage: radio [station]'
   exit
 end
 
@@ -37,13 +37,10 @@ if ARGV[0] == 'next'
   exit
 end
 
-if channels.has_key? channel.to_sym
+if channels.key? channel.to_sym
 
   selection = channels[channel.to_sym]
-
-  if ['yesterday', 'today', 'tomorrow'].include? ARGV[1]
-    selection[:period] = '/'+ARGV[1]
-  end
+  selection[:period] = '/' + ARGV[1] if %w(yesterday today tomorrow).include? ARGV[1]
 
   Schedule.new.load selection
 else

data/bin/sport

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require 'auntie'
 
-if ['help', '-h', '--help'].include? ARGV[0]
+if %w(help -h --help).include? ARGV[0]
   puts 'Useage: sport'
   exit
 end

data/bin/tv

@@ -2,29 +2,29 @@
 require 'auntie'
 
 channels = {
-  :one => { :id => 'bbcone', :region => '/london' },
-  :two => { :id => 'bbctwo', :region => '/england' },
-  :three => { :id => 'bbcthree' },
-  :four => { :id => 'bbcfour' },
-  :cbeebies => { :id => 'cbeebies' },
-  :cbbc => { :id => 'cbbc' },
-  :news => { :id => 'bbcnews' },
-  :parliament => { :id => 'parliament' },
-  :alba => { :id => 'alba', }
+  one: { id: 'bbcone', region: '/london' },
+  two: { id: 'bbctwo', region: '/england' },
+  three: { id: 'bbcthree' },
+  four: { id: 'bbcfour' },
+  cbeebies: { id: 'cbeebies' },
+  cbbc: { id: 'cbbc' },
+  news: { id: 'bbcnews' },
+  parliament: { id: 'parliament' },
+  alba: { id: 'alba' }
 }
 
 channel = ARGV[0] || :one
 
 if ARGV[0] == 'help' && ARGV[1] == '-c'
-  channels.each { |k,v| puts k }
+  channels.each { |k, v| puts k }
   puts "now\nnext"
   exit
 end
 
-helps = ['help', '-h', '--help']
+helps = %w(help -h --help)
 
 if helps.include? ARGV[0]
-  puts 'Useage: tv <channel>'
+  puts 'Useage: tv [channel]'
   exit
 end
 
@@ -38,7 +38,7 @@ if ARGV[0] == 'next'
   exit
 end
 
-if channels.has_key? channel.to_sym
+if channels.key? channel.to_sym
   Schedule.new.load channels[channel.to_sym]
 else
   puts "'#{channel}' is an unknown channel"

data/bin/weather

@@ -2,13 +2,14 @@
 require 'auntie'
 
 if ARGV[0] == 'help' && ARGV[1] == '-c'
-  puts "--location-search\n--hourly\n--daily"  #loc-search doesn't seem to be compatible with zsh completion?
+  # loc-search doesn't seem to be compatible with zsh completion?
+  puts "--location-search\n--hourly\n--daily"
   exit
 end
 
-if ['help', '-h', '--help'].include? ARGV[0]
+if %w(help -h --help).include? ARGV[0]
   puts 'Useage: weather <Postcode or BBC location id>'
-  puts '                --location-search <place>'
+  puts '                --location-search <place name>'
   puts '                --hourly <Postcode or BBC location id>'
   puts '                --daily <Postcode or BBC location id>'
   exit
@@ -17,15 +18,15 @@ end
 if ARGV[0] == '--location-search'
   place = ARGV[1..-1].join(' ')
 
-  abort "Please specify a location to search for." if place.empty?
-  place = "Hadfield" if place.downcase == 'royston vasey'
+  abort 'Please specify a location to search for.' if place.empty?
+  place = 'Hadfield' if place.downcase == 'royston vasey'
 
   Location.new.find(place)
   exit
 end
 
 def location
-  ARGV[0] ||= '2643743'  #Default to London.
+  ARGV[0] ||= '2643743' # Default to London.
 end
 
 action = ARGV[0]

data/features/step_definitions/location_steps.rb

@@ -1,7 +1,7 @@
-When /^I enter the place name$/ do
+When(/^I enter the place name$/) do
   #
 end
 
-Then /^a list of potential matches is shown$/ do
+Then(/^a list of potential matches is shown$/) do
   #
 end

data/features/step_definitions/weather_steps.rb

@@ -1,4 +1,4 @@
-When /^I get help for "([^"]*)"$/ do |app_name|
+When(/^I get help for "([^"]*)"$/) do |app_name|
   @app_name = app_name
   step %(I run `#{app_name} help`)
 end

data/features/support/env.rb

@@ -1,7 +1,7 @@
 require 'aruba/cucumber'
 
 ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
-LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib')
 
 Before do
   # Using "announce" causes massive warnings on 1.9.2

data/lib/bbc/location.rb

@@ -1,12 +1,16 @@
 # encoding: utf-8
 
+# Discovers BBC location ids
+#
 class Location
-  def initialize(io=STDOUT)
+  include ShellColors
+
+  def initialize(io = STDOUT)
     @io = io
   end
 
   def find(place)
-    abort "Please use a longer search term" if place.length < 3
+    fail 'Please use a longer search term' if place.length < 3
 
     @io.print "Searching for #{place}..."
 
@@ -14,16 +18,16 @@ class Location
   end
 
   def url(term)
-    "http://www.bbc.co.uk/locator/default/en-GB/autocomplete.json?search=#{URI::encode(term)}&filter=domestic&ptrt=/"
+    escaped = URI.encode(term)
+    "http://www.bbc.co.uk/locator/default/en-GB/autocomplete.json?search=#{escaped}&filter=domestic&ptrt=/"
   end
 
   def load(place)
     begin
-     raw = open(url(place), 'UserAgent' => AUNTIE::USER_AGENT).read
-     data = JSON.parse(raw)
+      raw = open(url(place), 'UserAgent' => AUNTIE::USER_AGENT).read
+      data = JSON.parse(raw)
     rescue
-      @io.puts "Unable to download location data"
-      exit
+      raise 'Unable to download location data'
     end
 
     @io.print "\r"
@@ -31,13 +35,13 @@ class Location
     if data.empty?
       @io.puts "No locations found matching '#{place}'   "
     else
-      @io.puts sprintf "%-42s %-10s", 'Place', 'ID'
+      @io.puts sprintf '%-42s %-10s', 'Place', 'ID'
       data.each do |e|
         name = e['fullName'].split(',')
-        place = light_green(name[0]+ ',') + green(name[1])
+        place = light_green(name[0] + ',') + green(name[1])
         id = cyan e['id']
 
-        @io.puts sprintf "%-60s %-10s", place, id
+        @io.puts sprintf '%-60s %-10s', place, id
       end
     end
   end

data/lib/bbc/news.rb

@@ -1,27 +1,28 @@
 # encoding: utf-8
 
+# Provides a list of the latest BBC News headlines
+#
 class News
-  def initialize(io=STDOUT)
+  def initialize(io = STDOUT)
     @io = io
   end
 
   def load
     cols = console_columns
     @io.puts 'BBC News Headlines'
-    data['entries'].each { |news_item|
-      @io.puts news_item['headline'][0..cols-1]
-    }
+    data['entries'].each do |news_item|
+      @io.puts news_item['headline'][0..cols - 1]
+    end
   end
 
   private
 
   def data
     begin
-     raw = open('http://www.bbc.co.uk/news/10284448/ticker.sjson', 'UserAgent' => AUNTIE::USER_AGENT).read
-     JSON.parse(raw)
+      raw = open('http://www.bbc.co.uk/news/10284448/ticker.sjson', 'UserAgent' => AUNTIE::USER_AGENT).read
+      JSON.parse(raw)
     rescue
-      @io.puts "Unable to download news"
-      exit
+      raise 'Unable to download news'
     end
   end
 

data/lib/bbc/now_next.rb

@@ -1,33 +1,37 @@
 # encoding: utf-8
 
+# Lists what is airing now and next accross BBC Radio and Television stations
+#
 class NowNext
-  def initialize(io=STDOUT)
+  include Timings
+
+  def initialize(io = STDOUT)
     @io = io
   end
 
   def tv_now
-    @fmt = "%-18s %s"
+    @fmt = '%-18s %s'
     load 'tv'
 
     on_now
   end
 
   def tv_next
-    @fmt = "%-18s %s"
+    @fmt = '%-18s %s'
     load 'tv'
 
     on_next
   end
 
   def radio_now
-    @fmt = "%-32s %s"
+    @fmt = '%-32s %s'
     load 'radio'
 
     on_now
   end
 
   def radio_next
-    @fmt = "%-32s %s"
+    @fmt = '%-32s %s'
     load 'radio'
 
     on_next
@@ -37,56 +41,52 @@ class NowNext
 
   Programme = Struct.new(:channel, :title, :starts, :starts_in)
 
-  def load medium
+  def load(medium)
     begin
-     raw = open("http://www.bbc.co.uk/iplayer/ion/multinownext/service_type/#{medium}/simulcast_only/1/format/json", 'UserAgent' => AUNTIE::USER_AGENT).read
-     @data = JSON.parse(raw)
+      raw = open("http://www.bbc.co.uk/iplayer/ion/multinownext/service_type/#{medium}/simulcast_only/1/format/json", 'UserAgent' => AUNTIE::USER_AGENT).read
+      @data = JSON.parse(raw)
     rescue
-      @io.puts "Unable to download #{medium} schedules"
-      exit
+      raise "Unable to download #{medium} schedules"
     end
   end
 
   def on_now
-    @data['blocklist'].each { |e|
+    @data['blocklist'].each do |e|
       channel = format_channel e['title']
       programme = e['now'][0]['episode']['passionsite_title'] rescue next
 
       @io.puts sprintf @fmt, channel, programme
-    }
+    end
   end
 
   def on_next
     programmes = []
 
-    first = 9
     second = 0
 
-    @data['blocklist'].each { |e|
+    @data['blocklist'].each do |e|
       p = Programme.new
       p.channel = format_channel e['title']
 
       p.title = e['next'][0]['episode']['passionsite_title'] rescue ''
       p.starts = Time.parse(e['next'][0]['start_time_iso']) rescue ''
 
-      #next_start = starts.strftime("%H:%M")
+      # next_start = starts.strftime("%H:%M")
       p.starts_in = how_long_between(time_now, p.starts)
 
-      second = p.channel.length+3 if p.channel.length > second
+      second = p.channel.length + 3 if p.channel.length > second
 
       programmes << p
-    }
+    end
 
     programmes.sort_by! { |p| p.starts }
 
-    programmes.each { |p|  @io.puts sprintf "%-#{first}s %-#{second}s %s", p.starts_in, p.channel, p.title }
-  end
-
-  def format_channel name
-    name.gsub(/^BBC | (London|England|Channel)/,'')
+    programmes.each do |p|
+      @io.puts sprintf("%-9s %-#{second}s %s", p.starts_in, p.channel, p.title)
+    end
   end
 
-  def time_now
-    Time.now
+  def format_channel(name)
+    name.gsub(/^BBC | (London|England|Channel)/, '')
   end
 end