sick-beard 1.0.0.pre

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODhhNDM5YzU4YjBjNTQ4NWQ0MTEyOTllNjgwNzc0Zjc1ZGM5MGNhYw==
+  data.tar.gz: !binary |-
+    NDdjZmQwYzgzMWNlY2MyY2VlYWE5NWFjODkwNzJjODNjM2U4OGQxZQ==
+SHA512:
+  metadata.gz: !binary |-
+    NGJmNWE0MzYwZjAxZTliZmQ4MDZhNjZkMGM0NDYwZDQwNTI4M2M1YmE5YmJl
+    Nzk3MjZjYjZiMDMwZjY3NGJiNjczMGQyNzdjYWQ0NTNmYWJkMTJhYTllZTcz
+    YWUxZTcyODNjYWQzYzAyYjllNThiOGYyNjQ4ZTM4MDhlMWQ0Y2E=
+  data.tar.gz: !binary |-
+    YzFlY2M0NzZmYWI5MmI1MzYzOGRmMGY3OTBiYjAyMTk3YjRjNjAzZGU4MWZh
+    NTU3YjI1N2NkZTU2YmYxY2FkMzM4MDAyODcyMmY5Yjg2NDc2MzllM2ZkNGVl
+    ZjEyYTIwOGE0ZjgwMTA2MTA5NjhkYjQzODIwOWFiYjk1ZGQzYzg=

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# RVM
+.rvmrc
+.ruby-gemset
+.ruby-version
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# OSX artifacts
+.DS_Store
+
+# RubyMine
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Changelog.md

@@ -0,0 +1,19 @@
+# SickBeard Gem Changelog
+
+## 0.0.6 - 2012/09/18
+
+ * Add #addnew and #delete methods to Show from work by nickmeessen.
+
+## 0.0.5 - 2012/09/15
+
+ * Fix for issue #1
+
+## 0.0.4 - 2012/08/14
+
+* Ensure that if we load all shows, we get the season_list from the server if
+  necessary.
+* Implement sb.searchtvdb API call simply.
+* Implement show.refresh.
+
+## 0.0.3 - 2012/08/13
+* Add further YARD documentation for the Show class.

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', all_after_pass: true, keep_failed: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kevin McDermott
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Sick Beard [![Build Status](https://travis-ci.org/RLovelett/sick-beard.png?branch=master)](https://travis-ci.org/RLovelett/sick-beard) [![Coverage Status](https://coveralls.io/repos/RLovelett/sick-beard/badge.png?branch=master)](https://coveralls.io/r/RLovelett/sick-beard?branch=master)
+
+The `sick-beard` gem provides a Ruby interface for interacting with the [Sick Beard PRV API](http://sickbeard.com/api/). Pull requests are always welcome.
+
+## Author
+
+[Ryan Lovelett](http://ryan.lovelett.me/) ( [@rlovelett](http://twitter.com/#!/rlovelett) )
+
+Drop me a message for any questions, suggestions, requests, bugs or
+submit them to the [issue
+log](https://github.com/rlovelett/sports_data_api/issues).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sick-beard'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sick-beard
+
+## Usage
+
+The specs for this Gem should give you some idea of how to make use of
+the API. For now they will be the usage information. As always Pull
+Requests for better documentation are welcome.
+
+## Testing
+
+The tests for the API have been mocked using [VCR](https://github.com/vcr/vcr) and [WebMock](https://github.com/bblimke/webmock).
+
+Actual calls to a Sick Beard have been mocked out to prevent storage of valid API credentials and making
+superflous API calls while testing. As such, in order to generically run the tests (without actually hitting)
+the server the only thing that needs to be done is to run the specs (e.g., `bundle exec rake spec` or
+`bundle exec guard start`).
+
+However, if you want to refresh the actual server API responses you will need to re-record all of the VCR cassettes.
+This can be achieved simply by performing the following two steps:
+
+1. Delete all the cassettes (`rm spec/cassettes/*.yml`)
+2. Run specs passing the API key as environment variable (`SPORTS_DATA_<NBA|NFL>_API_KEY=realapikey bundle exec rake spec`)
+
+## Contributing
+
+1. Fork it
+2. Create a topic branch (`git checkout -b topic`)
+3. Make your changes
+4. Squash your changes into one commit
+5. Create new Pull Request against this squashed commit

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sickbeard.rb

@@ -0,0 +1,53 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'cgi'
+
+module SickBeard
+  # This class provides all the methods for using the SickBeard API.
+  class Base
+
+    # @option options [String] :api_key ("") The SickBeard username for access.
+    # @option options [String] :server ("") The server API endpoint.
+    # @return [Object] the object.
+    def initialize(options = {})
+
+      options = { api_key: '',
+        server: '',
+      }.merge(options)
+
+      @server = options[:server]
+      @api_key = options[:api_key]
+      raise ArgumentError, 'No :api_key provided' if options[:api_key].nil? || options[:api_key].empty?
+      raise ArgumentError, 'No :server provided' if options[:server].nil? || options[:server].empty?
+    end
+
+    # Makes an API call to a SickBeard server
+    #
+    # @param [String] cmd SickBeard API call to request
+    # @param [Hash] options the options to make the API call with, these are
+    #   passed as GET parameters to the SickBeard server.
+    # @return [String] the HTTP response
+    def make_request(cmd, options = {})
+      options = { cmd: cmd }.merge(options)
+      path = "/api/#{@api_key}/"
+      uri = URI::join(URI.parse(@server), path)
+      uri.query = URI.encode_www_form( options )
+      Net::HTTP.get(uri)
+    end
+
+    # Makes an API call to a SickBeard server returns JSON parsed result
+    # @see make_request
+    # @return [Hash] JSON parsed result from the remote server
+    def make_json_request(cmd, options = {})
+      response = JSON.parse(make_request(cmd, options))
+      raise Error.new(response['message']) if response['result'] != 'success'
+      response
+    end
+  end
+
+  # Raised when the remote server returns a non-success response
+  class Error < RuntimeError; end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'sickbeard/**/*.rb')].sort.each { |lib| require lib }

data/lib/sickbeard/api.rb

@@ -0,0 +1,64 @@
+module SickBeard
+
+  class Client < Base
+
+    # Returns misc SickBeard related information.
+    def sb
+      make_json_request('sb')
+    end
+
+    # Returns the upcoming episodes for the shows currently added in the
+    # users' database.
+
+    # @param [Hash] options optional parameters for the SickBeard API call
+    # @option options [String] :sort (nil) Option to sort the results:
+    #   * date 
+    #   * network
+    #   * name
+    #
+    # @option options [Array<String>] :filter (nil) Option to filter the results:
+    #   * missed - show's date is older than today
+    #   * today - show's date is today
+    #   * soon - show's date greater than today but less than a week
+    #   * later - show's date greater than a week
+    # @return [Object] the object.
+    def future(options = {})
+      filter = (options[:type] || []).join('|')
+      make_json_request('future', type: filter, sort: options[:sort])['data']
+    end
+
+    # Returns global episode and show statistics.
+    def shows_stats
+      make_json_request('shows.stats')['data']
+    end
+
+    # Returns a list of all shows in SickBeard.
+    def shows(options = {})
+      make_json_request('shows', sort: options[:sort])['data'].collect do |key, response|
+        # SickBeard API returns different things based on your sort.
+        if options[:sort] == 'name'
+          response['show_name'] = key
+          show_id = response['tvdbid']
+        else
+          show_id = key
+        end
+        Show.from_response(self, show_id, response)
+      end
+    end
+
+    # Returns information for a given show.
+    # @param [String] show_id the tvdbid for the show to fetch
+    # @return [SickBeard::Show]
+    def show(show_id)
+      Show.from_response(self, show_id, make_json_request('show', tvdbid: show_id)['data'])
+    end
+
+    # Search for Shows by name
+    # @param [String] name the show to match on.
+    def searchtvdb(name)
+      make_json_request('sb.searchtvdb', name: name)['data']['results'].collect do |result|
+        Show.from_response(self, result['tvdbid'], result)
+      end
+    end
+  end
+end

data/lib/sickbeard/show.rb

@@ -0,0 +1,152 @@
+module SickBeard
+
+  class Show
+    # @!attribute [r] name
+    #   @return [String] the name of the Show
+    # @!attribute [r] genres
+    #   @return [Array(String)] genres for this Show
+    # @!attribute [r] status
+    #   @return [String] the status for this Show
+    #     * Continuing
+    #     * Ended
+    # @!attribute [r] season_list
+    #  @return [Array(String)] list of known Series for this Show
+    # @!attribute [r] server
+    #  @return [SickBeard::Client] the server this Show was loaded from
+    # @!attribute [r] tvdbid
+    #  @return [Integer] the tvdbid for this Show
+    # @!attribute [r] quality
+    #  @return [String] The download quality for this Show e.g. SD
+    attr_reader :name, :genres, :status, :server, :tvdbid, :quality
+
+    def self.from_response(server, tvdbid, response)
+      options = {
+        name: response['show_name'] || response['name'],
+        genres: response['genre'],
+        status: response['status'],
+        season_list: response['season_list'],
+        quality: response['quality'],
+        server: server,
+        tvdbid: tvdbid
+      }
+      Show.new(options)
+    end
+
+    # Create a new Show
+    # @option options [String] :name ("") The name for this show
+    # @option options [Array(String)] :genres ("") array of genres applicable to this show.
+    # @return [Object] the object.
+    def initialize(options = {})
+
+      options = { name: '',
+        genres: '',
+        status: '',
+        season_list: [],
+      }.merge(options)
+      @name = options[:name]
+      @genres = options[:genres]
+      @status = options[:status]
+      @season_list = (options[:season_list] || []).sort
+      @server = options[:server]
+      @tvdbid = options[:tvdbid]
+      @quality = options[:quality]
+    end
+
+    # Add this show to SickBeard to be tracked.
+    # @param [Hash] Options to be passed (location, lang, season_folder, status, initial, archive)
+    def addnew(options = {})
+
+      options[:initial] = [*(options[:initial] || [])].join('|') if options[:initial]
+      options[:archive] = [*(options[:archive] || [])].join('|') if options[:archive]
+
+      options = { tvdbid: @tvdbid }.merge(options)
+
+      @server.make_json_request('show.addnew', options)['message']
+    end
+
+    # Remove this show from SickBeard.
+    def delete
+      @server.make_json_request('show.delete', tvdbid: @tvdbid)['message']
+    end
+
+    # Retrieve a listing of episodes for all or a given season.
+    # @param [Integer] season optional if provided, fetch only episodes for
+    #  the provided season otherwise pulls details down for every season of the how.
+    # @return [Array(Hash)]  of season details
+    def seasons(season = nil)
+      @server.make_json_request('show.seasons', tvdbid: @tvdbid, season: season)['data']
+    end
+
+    # Retrieve the stored banner image from SickBeard's cache for this show.
+    # @return image data (JPEG format)
+    def get_banner
+      @server.make_request('show.getbanner', tvdbid: @tvdbid)
+    end
+
+    # Retrieve the stored poster image from SickBeard's cache for this show.
+    # @return image data (JPEG format)
+    def get_poster
+      @server.make_request('show.getposter', tvdbid: @tvdbid)
+    end
+
+    # Set a show's paused state in SickBeard.
+    def pause
+      @server.make_json_request('show.pause', tvdbid: @tvdbid, pause: 1)['message']
+    end
+
+    # Set a show's paused state in SickBeard.
+    def unpause
+      @server.make_json_request('show.pause', tvdbid: @tvdbid)['message']
+    end
+
+    # Retrieve a show's paused state in SickBeard.
+    # @return [Boolean] indicating whether or not this Show is paused
+    def paused?
+      @server.make_json_request('show', tvdbid: @tvdbid)['data']['paused'] == 1
+    end
+
+    # Set desired quality of a show in SickBeard.
+    # @option options [String, Array] :initial ([]) either a single quality SD
+    #   or HD, or an array of allowable video quality definitions for downloading.
+    # @option options [String, Array] :archive ([]) either a single quality SD
+    #   or HD, or an array of allowable video quality definitions for archiving.
+    def set_quality(options)
+      initial = [*(options[:initial] || [])].join('|')
+      archive = [*(options[:archive] || [])].join('|')
+      @server.make_json_request('show.setquality', tvdbid: @tvdbid, initial: initial, archive: archive)['message']
+    end
+
+    def season_list
+      if @season_list.empty?
+        @season_list = @server.make_json_request('show.seasonlist', tvdbid: @tvdbid)['data'].sort
+      end
+      @season_list
+    end
+
+    # Returns episode statistics for this show.
+    def stats
+      @server.make_json_request('show.stats', tvdbid: @tvdbid)['data']
+    end
+
+    # Returns true if SickBeard's poster image cache is valid
+    def has_cached_poster?
+      @server.make_json_request('show.cache', tvdbid: @tvdbid)['data']['poster'] == 1
+    end
+
+    # Returns true if SickBeard's banner image cache is valid
+    def has_cached_banner?
+      @server.make_json_request('show.cache', tvdbid: @tvdbid)['data']['banner'] == 1
+    end
+
+    #  Update a show in SickBeard by pulling down information from TVDB and rescan
+    #  local files.
+    def update
+      @server.make_json_request('show.update', tvdbid: @tvdbid)['message']
+    end
+
+    #  Refresh a show in SickBeard by rescanning local files.
+    def refresh
+      @server.make_json_request('show.refresh', tvdbid: @tvdbid)['message']
+    end
+  end
+end