film_on 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08b8f5e02f433943c4e6c6b9f19ea44f350d8110
-  data.tar.gz: ddc83e4f1d96f1316ede69dbfab3a9ad1ea406df
+  metadata.gz: b6daa5c3826eabbbc14f6fbdbbd2c5b188a76725
+  data.tar.gz: 74858705d1db4df5dd193a8afe35a321d5f45134
 SHA512:
-  metadata.gz: 86fc9879cb397f3bac8a690d01e1af7c9755c70114ca350521419d1a28d5ef0fa59e8479e4eac402229ce2700f09b1ca0a7f38d1e40fe06b83ed7149d2defe5f
-  data.tar.gz: 553d3e11e53e8426e4c478ecd6396d913c2d0c84eb5062ab44d74cc5ac0246fb2a614e51dc96835c3ffdcbc002d62a543c4c86974e43eafa21334b062bf7440a
+  metadata.gz: 3d38f63ee5436ff621c56564fc2d75a647257298e4421616489c8819470e6f0f1db07fe43133a777a7a262d30bcfc9656463c6d4f77ba1324679e99f80549046
+  data.tar.gz: 356205369ac03fd4fed40cd60ddb692b6e047c0933b6c2470b42f026cb4027a841d71df1df5fe7ad21b3ebd40fe2852ad11c17abb0915b5b436a49d745638aee

data/README.md

@@ -36,6 +36,7 @@ film_on = FilmOn::Base.new(app_key, app_secret)
 film_on.channels => returns list of all channels as ruby objects
 flim_on.groups => returns list of all groups as ruby objects
 film_on.channel(id) => returns info for given channel as a ruby object
+film_on.find_group(id) => returns the information for a given group id
 
 ## Development
 

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/film_on/base.rb

@@ -12,6 +12,17 @@ module FilmOn
 
     attr_reader :app_key, :app_secret, :session_key
 
+    class ApiError < StandardError; end
+
+    # FilmOn Api (http://www.filmon.com/page/api)
+    # initialize the wrapper with your app_key and app_secret
+    # for development purposes you can use "foo" and "bar"
+    # eg.
+    # film_on = FilmOn::Base.new("foo", "bar")
+    # film_on.channels => returns an array of channels
+    # film_on.groups => returns an array of channel groups
+    # film_on.channel(14) => returns information for channel with id 14
+    #
     def initialize(app_key, app_secret)
       @app_key = app_key
       @app_secret = app_secret
@@ -19,6 +30,11 @@ module FilmOn
       init_request
     end
 
+    private
+
+    # Create the initial handshake to FilmOn
+    # and set the @session_key
+    #
     def init_request
       response = get("init")
       init_hash = JSON.parse(response)
@@ -26,8 +42,8 @@ module FilmOn
       self
     end
 
-    private
-
+    # Make a POST request to the api with the given service, query and protocol
+    #
     def post(service, query={}, protocol="http://")
       query["format"] = "json"
       query["session_key"] = @session_key unless service == "init"
@@ -36,10 +52,12 @@ module FilmOn
       if response && response.code == 200
         return response.body
       else
-        response.response
+        raise ApiError
       end
     end
 
+    # Make a GET request to the api with the given service, query and protocol
+    #
     def get(service, query={}, protocol="http://")
       query["format"] = "json"
       query["session_key"] = @session_key unless service == "init"
@@ -48,7 +66,7 @@ module FilmOn
       if response && response.code == 200
         return response.body
       else
-        response.response
+        raise ApiError
       end
     end
 

data/lib/film_on/helpers/channel_helper.rb

@@ -2,15 +2,24 @@ module FilmOn
 
   module ChannelHelper
 
-      def convert_channel(json)
-        hash = JSON.parse(json)
-        FilmOn::Channel.new(hash)
-      end
+    # #convert_channel takes the raw JSON
+    # and coverts it into a nice ruby object
+    # normal for use after storing the JSON in
+    # a caching mechanism
+    #
+    def convert_channel(json)
+      hash = JSON.parse(json)
+      FilmOn::Channel.new(hash)
+    end
 
-      def convert_channels(json)
-        hash = JSON.parse(json)
-        hash.map{|ch| FilmOn::Channel.new(ch)}
-      end
+    # #convert_channel takes the raw JSON
+    # and coverts it into a nice ruby array of
+    # objects
+    #
+    def convert_channels(json)
+      hash = JSON.parse(json)
+      hash.map{|ch| FilmOn::Channel.new(ch)}
+    end
 
   end
 end

data/lib/film_on/helpers/group_helper.rb

@@ -1,12 +1,19 @@
 module FilmOn
   module GroupHelper
 
+    # #convert_groups takes the raw JSON
+    # and converts it into a nice ruby array of objects
+    #
     def convert_groups(json)
       hash = JSON.parse(json)
       hash.map{|gr| FilmOn::Group.new(gr)}
     end
 
+    # #find_group, a convenience method to
+    # find the full detail of any given group
+    #
     def find_group(id)
+      id = id.to_s
       groups.select{|gr| gr.id == id}.first
     end
 

data/lib/film_on/models/channel.rb

@@ -3,7 +3,8 @@ module FilmOn
   # FilmOn::Channel
   # Channel can have either a basic set of data or a more verbose set
   # depending on whether it is called as part of a channels list or
-  # as in individual call
+  # as in individual call from #channel, takes a raw hash and converts
+  # it into a nice ruby object
 
   class Channel
 

data/lib/film_on/models/group.rb

@@ -1,5 +1,10 @@
 module FilmOn
 
+  # Group is a group of channels bundled together
+  # such as "Sports" or "UK Live TV"
+  # takes a raw hash and converts it into a nice ruby
+  # object
+
   class Group
 
     attr_reader :hash

data/lib/film_on/models/programme.rb

@@ -1,5 +1,8 @@
 module FilmOn
 
+  # Programme holds the detail of a TV programme, it takes a raw hash and
+  # converts it into a nice ruby object
+  #
   class Programme
 
     Image = Struct.new(:id, :type, :size, :width, :height, :url, :copyright)

data/lib/film_on/services.rb

@@ -1,8 +1,18 @@
 module FilmOn
 
+  # Services: calls to the actual services of the API
+  # each call is memoized to save calling the API multiple times
+  # except when json requested:
+  # pass {json: true} to get the raw JSON representation
+  # of the channel, normally for self storage in memcache/redis cache
+  #
   module Services
 
+    # #channel will get the verbose details for a channel with
+    # the given id
+    #
     def channel(id, opts={})
+      id = id.to_s
       return @channel[id] if @channel[id] && !opts[:json]
       json = get("channel/#{id}")
       if opts[:json]
@@ -11,6 +21,10 @@ module FilmOn
       @channel[id] = convert_channel(json)
     end
 
+    # #channels will get the entire current list of channels for
+    # FilmOn, each channels has a small amount of useful data,
+    # refer to #channel for additional channel information.
+    #
     def channels(opts={})
       return @channels if @channels && !opts[:json]
       json = get("channels")
@@ -20,6 +34,9 @@ module FilmOn
       @channels = convert_channels(json)
     end
 
+    # #groups will get the entire current list of groups for
+    # FilmOn, each group holds an array of ids of associated channels
+    #
     def groups(opts={})
       return @groups if @groups && !opts[:json]
       json = get("groups")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: film_on
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Stuart Hanscombe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler