rviki 0.0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 2012-04-10 14:00:00 +0000 Nia M <nia@viki.com>
+
+* Created rviki

data/README.md

@@ -0,0 +1,34 @@
+# RViki readme
+
+
+RViki is a Ruby client gem for Viki.com API.
+
+
+## Usage
+
+### Client Request
+
+    v = RViki::Client.new
+    v.shows
+    v.shows(language_code: "en")
+    v.shows(id: 50)
+    v.shows(id: 50, language_code: "es")
+
+### Print Utilities
+
+    vpr = RViki::Printer.new([:clipboard, :stdout])
+    vpr.object = v.shows.parsed_response["films"]
+    vpr.tabular
+    vpr.pretty_ruby
+    vpr.pretty_json
+
+Clipboard output is only for Mac, for now.
+
+### Woot! Command Line!
+
+    $ rviki shows
+    $ rviki shows_item 50
+    $ rviki shows_item 50 es
+    $ rviki shows -f pretty_json 50
+    $ rviki shows -o clipboard,stdout 50
+

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require "rubygems"
+  require "bundler"
+rescue LoadError
+  raise "Could not load the bundler gem. Install it with `gem install bundler`."
+end
+
+if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("1.0.0")
+  raise RuntimeError, "Your bundler version is too old for Mail" +
+   "Run `gem install bundler` to upgrade."
+end
+
+begin
+  # Set up load paths for all bundled gems
+  ENV["BUNDLE_GEMFILE"] = File.expand_path("../Gemfile", __FILE__)
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require "rviki/version"
+
+task :build do
+  system "gem build rviki.gemspec"
+end
+
+task :release => :build do
+  system "gem push rviki-#{RViki::VERSION::STRING}"
+end

data/bin/rviki

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+begin
+  require "pathname"
+  bin_file = Pathname.new(__FILE__).realpath
+  $:.unshift File.expand_path("../lib", bin_file)
+
+  require "rviki/cli"
+  cli = RViki::Cli.new
+  cli.execute(*ARGV)
+rescue Interrupt
+  `stty icanon echo`
+  puts("\n !    Command cancelled.")
+end
+

data/lib/VERSION

@@ -0,0 +1,4 @@
+major:0
+minor:0
+patch:1
+build:

data/lib/rviki.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module RViki
+  require 'pp'
+  require 'json'
+  require 'httparty'
+  require 'rviki/version'
+  require 'rviki/routable'
+  require 'rviki/client'
+  require 'rviki/printer'
+end

data/lib/rviki/cli.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+
+require 'optparse'
+require 'rviki'
+
+module RViki
+  module Registrable
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def register_command(command_sym, args)
+        registered_commands[command_sym] = args
+      end
+
+      def registered_commands
+        @registered_commands ||= {}
+      end
+    end
+  end
+
+  class Cli
+    include Registrable
+
+    register_command :shows, [:language_code]
+    register_command :shows_item, [:id, :language_code]
+    register_command :featured, []
+    register_command :news, [:language_code]
+
+    register_command :channels, [:watchable_by_country, :lang_code]
+    register_command :channels_item, [:id, :watchable_by_country, :lang_code]
+    register_command :channel_videos, [:id]
+
+    register_command :posts, [:lang_code]
+
+    register_command :videos, []
+    register_command :video_casts, [:id]
+    register_command :video_parts, [:id]
+    register_command :video_posts, [:id]
+
+    def initialize
+      @client  = RViki::Client.new
+      @printer = RViki::Printer.new([:stdout])
+
+      @print_opts_parser = OptionParser.new do |pop|
+        pop.banner = "Print Options:"
+        pop.on("-f", "--format FORMAT", [:tabular, :pretty_json, :pretty_ruby],
+               "Print with FORMAT (tabular (only for array), pretty_json, or pretty_ruby)") do |pf|
+          printer.format = pf
+        end
+
+        pop.on("-o", "--output clipboard,stdout", Array,
+               "Output to OUTPUT_TARGET (clipboard, stdout)") do |o|
+          o = o.map(&:to_sym)
+          if (o.include?(:clipboard) || o.include?(:stdout))
+            printer.targets = o
+          end
+        end
+      end
+    end
+
+    def execute(*args)
+      @cmd = args.shift
+      @cmd = @cmd.to_sym if @cmd
+      unless valid_command?
+        puts <<-EOL
+
+Command not found: #{@cmd}
+----------------------------------------
+
+RViki Version #{RViki::VERSION::STRING} for Viki API V2
+Usage: rviki <api_endpoint> [--opt optvalue] [api_param1] [api_param2]
+
+Available API Endpoints:
+#{commands_listing}
+#{print_opts_parser}
+
+Examples:
+
+    $ rviki featured
+    $ rviki shows -o clipboard
+    $ rviki shows_item 50
+    $ rviki shows_item 50 es
+    $ rviki shows -f pretty_json 50
+    $ rviki shows -o clipboard,stdout 50
+
+EOL
+        exit(1)
+      end
+
+      @cmd_args = self.class.registered_commands[@cmd]
+      extract_options args
+      response = client.send(@cmd, client_options_hash)
+      printer.object = response.parsed_response
+      printer.do_print
+    end
+
+    protected
+
+    attr_reader :client, :printer, :client_options, :print_opts_parser
+
+    def commands_listing
+      result = ""
+      self.class.registered_commands.each do |endpoint, params|
+        result += "    #{endpoint}"
+        result += "\n        params: #{params.map{|pr| "[:#{pr}]"}.join(' ')}" if params && !params.empty?
+        result += "\n"
+      end
+      result
+    end
+
+    def extract_options(args)
+      client_opts_i = 0
+      args.each_with_index do |a, i|
+        client_opts_i += 2 if a.start_with?("-")
+      end
+
+      @printer_options = args[0...client_opts_i]
+      print_opts_parser.parse! @printer_options
+      @client_options = args[client_opts_i..-1]
+      true
+    end
+
+    def client_options_hash
+      options = {}
+      client_options.each_with_index do |a, i|
+        options[@cmd_args[i]] = a
+      end
+      options
+    end
+
+    def valid_command?
+      @cmd && !@cmd.empty? && self.class.registered_commands.has_key?(@cmd)
+    end
+  end
+end
+

data/lib/rviki/client.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module RViki
+  class Client
+    include Routable
+
+    base_uri 'http://www.viki.com/api/v2'
+    headers "Content-Type" => "application/json", "User-Agent" => "VikiMobile/4.0 RViki::Client"
+    format :json
+
+    route_get "/shows.json", as: :shows
+    route_get "/shows/:id.json", as: :shows_item
+    route_get "/featured.json", as: :featured
+    route_get "/news.json", as: :news
+
+    route_get "/channels.json", as: :channels
+    route_get "/channels/:id.json", as: :channels_item
+    route_get "/channel/:id/videos.json", as: :channel_videos
+
+    route_get "/posts.json", as: :posts
+
+    route_get "/videos.json", as: :videos
+    route_get "/videos/:id/casts.json", as: :video_casts
+    route_get "/videos/:id/parts.json", as: :video_parts
+    route_get "/videos/:id/recommended.json", as: :video_posts
+  end
+end
+

data/lib/rviki/printer.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+module RViki
+  class Printer
+    attr_accessor :targets, :object, :format
+
+    def initialize(print_targets=[:stdout])
+      self.targets = print_targets
+    end
+
+    def do_print
+      if self.format
+        begin
+          self.send(self.format)
+        rescue Exception
+          self.pretty_json
+        end
+      else
+        self.pretty_json
+      end
+    end
+
+    def tabular
+      return unless inputs_valid?
+      raise "Cannot print tabular data because parsed response is not an array" unless object.is_a?(Array)
+
+      out = object.first.keys.join("\t") + "\n"
+      object.each { |item| out += (item.values.join("\t") + "\n") }
+      do_output out
+    end
+
+    def pretty_ruby
+      return unless inputs_valid?
+      do_output object.pretty_inspect
+    end
+
+    def pretty_json
+      return unless inputs_valid?
+      do_output JSON.pretty_generate(object)
+    end
+
+    private
+
+    def inputs_valid?
+      raise "Please use array of symbols as targets" unless self.targets.is_a?(Array)
+      if !object || object.empty?
+        puts "[RViki::Client -- WARNING!] List is empty. Nothing to do here."
+        return false
+      end
+      true
+    end
+
+    def do_output(out)
+      self.targets.each do |target|
+        case target
+        when :stdout
+          puts out
+        when :clipboard
+          if command?('pbcopy')
+            IO.popen('pbcopy', 'r+') { |cl| cl.puts out }
+          elsif command?('xsel')
+            IO.popen('xsel –clipboard –input', 'r+') { |cl| cl.puts out }
+          else
+            puts "[RViki::Client] Cannot copy to clipboard. There is no pbcopy (Mac) or xsel (Linux) installed. Please look for one of them in Google. Thanks."
+          end
+        else
+          puts "[RViki::Client -- WARNING!] Invalid target #{target.inspect}"
+        end
+      end
+    end
+
+    def command?(name)
+      `which #{name}`
+      $?.success?
+    end
+  end
+end
+

data/lib/rviki/routable.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module RViki
+  module Routable
+    def self.included(base)
+      base.send :include, HTTParty
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def routes
+        @routes ||= {}
+      end
+
+      def route_get(route_pattern, args)
+        param_keys = route_pattern.scan(/:\w+/).map { |key| key[1..-1].to_sym }
+        api_name = args[:as]
+        routes[api_name] = [ route_pattern, param_keys ]
+
+        define_method(api_name) do |params={}|
+          request_path = route_pattern.dup
+          param_keys.each do |param_key|
+            if (value = params[param_key])
+              request_path.gsub!(":#{param_key}", value.to_s)
+              params.delete(param_key)
+            end
+          end
+          self.class.get(request_path, query: params)
+        end
+      end
+    end
+  end
+end
+

data/lib/rviki/version.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module RViki
+  module VERSION
+
+    version = {}
+    File.read(File.join(File.dirname(__FILE__), '../', 'VERSION')).each_line do |line|
+      type, value = line.chomp.split(":")
+      next if type =~ /^ +$/  || value =~ /^ +$/
+      version[type] = value
+    end
+
+    MAJOR = version['major']
+    MINOR = version['minor']
+    PATCH = version['patch']
+    BUILD = version['build']
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+
+    def self.version
+      STRING
+    end
+
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rviki
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nia M
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70117459607260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70117459607260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70117459605860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *70117459605860
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: &70117459605200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *70117459605200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70117459604300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *70117459604300
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70117459602640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+  type: :development
+  prerelease: false
+  version_requirements: *70117459602640
+description: A short description
+email:
+- nia@viki.com
+executables:
+- rviki
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG
+files:
+- README.md
+- Rakefile
+- lib/rviki/cli.rb
+- lib/rviki/client.rb
+- lib/rviki/printer.rb
+- lib/rviki/routable.rb
+- lib/rviki/version.rb
+- lib/rviki.rb
+- lib/VERSION
+- CHANGELOG
+- bin/rviki
+homepage: ''
+licenses:
+- ''
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A longer summary
+test_files: []