kewego_party 0.0.1

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - rbx-2.0
+  - ree

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+* 0.0.1
+  - Added api_cache as dependency to cache app_token

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Paco Guzmán
+
+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,47 @@
+# The Kewego Ruby Gem
+Simple ruby wrapper for Kewego API
+
+## <a name="installation">Installation</a>
+    gem install kewego_party
+
+## <a name="ci">Continuous Integration</a>
+[![Build Status](https://secure.travis-ci.org/aspgems/kewego_party.png)](http://travis-ci.org/aspgems/kewego_party)
+
+## <a name="examples">Examples</a>
+### <a name="video-details">Video Details</a>
+
+  ````ruby
+  client = KewegoParty::Client.new(:token => your_api_token)
+  client.video_get_details(video_identifier)
+  => <#Hashie::Rash access="public" audience_classification="all_public" author="charhadas" available_formats=<#Hashie::Rash format=["ipadHQ", "iphone", "iphone3G",   "normal", "old", "slides"]> available_subtitles="available_subtitle" broadcast_end_date="2037-12-31 23:59:59" broadcast_start_date="2011-07-06 13:26:20" categories=<#Hashie::Rash category="Actualidades"> chapter_available="no" comments="0" country="es" default_display_subtitle="none" default_format="sd" description="<p>Entrevista Charhadas</p>" duration="221" keywords=<#Hashie::Rash keyword=["entrevista", "ceos", "socias"]> language="es" metadata=nil pid="" postal_code="28023" production_date="0000-00-00 00:00:00" publication_date="2011-07-06 13:26:20" rate="0" rating_count="0" ratio="1.7778" slide_available="no" thumbnails=<#Hashie::Rash large=<#Hashie::Rash url=["http://tll.kewego.com/t/0/0071/400x300_iLyROoaf22Mr_1.jpg", "http://tll.kewego.com/t/0/0071/400x300_iLyROoaf22Mr_2.jpg", "http://tll.kewego.com/t/0/0071/400x300_iLyROoaf22Mr_3.jpg"]> medium=<#Hashie::Rash url=["http://tll.kewego.com/t/0/0071/154x114_iLyROoaf22Mr_1.jpg", "http://tll.kewego.com/t/0/0071/154x114_iLyROoaf22Mr_2.jpg", "http://tll.kewego.com/t/0/0071/154x114_iLyROoaf22Mr_3.jpg"]> small=<#Hashie::Rash url=["http://tll.kewego.com/t/0/0071/74x54_iLyROoaf22Mr_1.jpg", "http://tll.kewego.com/t/0/0071/74x54_iLyROoaf22Mr_2.jpg", "http://tll.kewego.com/t/0/0071/74x54_iLyROoaf22Mr_3.jpg"]>> title="Entrevista CharHadas" videoblog_link=nil views="16">
+  ````
+
+## <a name="pulls">Submitting a Pull Request</a>
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add specs for your feature or bug fix.
+5. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+6. Commit and push your changes.
+7. Submit a pull request. Please do not include changes to the version or gemspec. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+## <a name="rubies">Supported Rubies</a>
+This library aims to support and is [tested
+against](http://travis-ci.org/aspgems/kewego_party) the following Ruby
+implementations:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+* [Rubinius](http://rubini.us/)
+* [Ruby Enterprise Edition](http://www.rubyenterpriseedition.com/)
+
+If something doesn't work on one of these interpreters, it should be considered
+a bug.
+
+## <a name="inspiration">Inspiration</a>
+KewegoParty was inspired by [Octokit](https://github.com/pengwynn/octokit).
+
+## <a name="copyright">Copyright</a>
+Copyright (c) 2011 [ASPgems](http://aspgems.com).
+See [LICENSE](https://github.com/aspgems/kewego_party/blob/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/TODO.md

@@ -0,0 +1,4 @@
+## <a name="todos">TODOs</a>
+
+* Rails integration
+* How to submit a video to Kewego Platform

data/kewego_party.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kewego_party/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "kewego_party"
+  gem.rubyforge_project = "kewego_party party"
+  gem.summary = %q{Ruby wrapper for the Kewego API using HTTP Party}
+  gem.description = %q{Ruby wrapper for the Kewego API using HTTP Party}
+
+  gem.homepage = "https://github.com/aspgems/kewego_party"
+  gem.authors = ["Paco Guzman"]
+  gem.email = ["fjguzman@aspgems.com"]
+
+  gem.version = KewegoParty::VERSION
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.platform = Gem::Platform::RUBY
+  gem.require_paths = ['lib']
+  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+
+  gem.add_runtime_dependency 'httparty',    '~> 0.7.8'
+  gem.add_runtime_dependency 'multi_xml',   '~> 0.2'
+  gem.add_runtime_dependency 'rash',        '~> 0.3'
+  gem.add_runtime_dependency 'hashie',      '~> 1.0.0'
+  gem.add_runtime_dependency 'api_cache',   '~> 0.2.3'
+
+  gem.add_development_dependency 'rake',    '~> 0.9'
+  gem.add_development_dependency 'rspec',   '~> 2.6'
+  gem.add_development_dependency 'vcr',     '~> 1.10'
+  gem.add_development_dependency 'webmock', '~> 1.6'
+end

data/lib/kewego_party.rb

@@ -0,0 +1,29 @@
+require "kewego_party/version"
+
+require 'api_cache'
+
+require 'kewego_party/configuration'
+require 'kewego_party/client'
+require 'kewego_party/exceptions'
+
+module KewegoParty
+  extend Configuration
+  class << self
+    # Alias for KewegoParty::Client.new
+    #
+    # @return [KewegoParty::Client]
+    def new(options={})
+      KewegoParty::Client.new(options)
+    end
+
+    # Delegate to KewegoParty::Client.new
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/kewego_party/cache.rb

@@ -0,0 +1,42 @@
+module KewegoParty
+  module Cache
+
+    def app_reset_app_token
+      with_caching(app_token_cache_key, :cache => 0, :period => 0) do
+        app_get_token
+      end
+    end
+
+    def app_token
+      self.app_token = with_caching(app_token_cache_key, :cache => app_token_cache_timeout, :period => 0) do
+        app_get_token
+      end
+      @app_token
+    end
+
+    def app_token=(token)
+      @app_token = token
+    end
+
+    protected
+    def with_caching(key, options)
+      APICache.get(key, options) do
+        yield
+      end
+    rescue APICache::TimeoutError => err
+      raise KewegoParty::TimeoutException.new
+    end
+
+    def app_token_cache_key
+      'app_get_token'
+    end
+
+    def app_token_cache_timeout
+      22 * 3600
+    end
+
+    def cache_fail
+      raise
+    end
+  end
+end

data/lib/kewego_party/client.rb

@@ -0,0 +1,52 @@
+require 'httparty'
+
+require 'kewego_party/cache'
+require 'kewego_party/connection'
+require 'kewego_party/request'
+
+require 'kewego_party/client/app'
+require 'kewego_party/client/auth'
+require 'kewego_party/client/channel_list'
+require 'kewego_party/client/channel'
+require 'kewego_party/client/upload'
+require 'kewego_party/client/video'
+
+module KewegoParty
+  class Client
+    include ::HTTParty
+
+    include KewegoParty::Cache
+    include KewegoParty::Connection
+    include KewegoParty::Request
+
+    include KewegoParty::Client::App
+    include KewegoParty::Client::Auth
+    include KewegoParty::Client::ChannelList
+    include KewegoParty::Client::Channel
+    include KewegoParty::Client::Upload
+    include KewegoParty::Client::Video
+
+    attr_accessor(*(Configuration::VALID_OPTIONS_KEYS - [:app_token]))
+
+    def initialize(options={})
+      options = KewegoParty.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def caching_store=(store)
+      @caching_store = store
+      APICache.store = store
+    end
+
+    private
+    def process_response(response, xml_path = [])
+      Array(xml_path).unshift(:kewego_response, :message).inject(response) do |response, path|
+        raise KewegoParty::InvalidResponseException.new(path) unless response.key?(path)
+
+        response[path]
+      end
+    end
+  end
+end

data/lib/kewego_party/client/app.rb

@@ -0,0 +1,16 @@
+module KewegoParty
+  class Client
+    module App
+      def app_get_token
+        response = get("/app/getToken/", {:appKey => token})
+        self.app_token = process_response(response, [:app_token])
+        @app_token
+      end
+
+      def app_check_token
+        response = get("/app/checkToken/", {:appKey => token, :appToken => app_token})
+        process_response(response, [:app_token])
+      end
+    end
+  end
+end

data/lib/kewego_party/client/auth.rb

@@ -0,0 +1,35 @@
+module KewegoParty
+  class Client
+    module Auth
+      # Generates a user token needed for adding and updating data in kewego
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :username(configuration.login). User name to login
+      # @option options [String] :password(configuration.password). Password to login
+      # @return [String] returns the user token
+      # @see http://developers.kewego.com/documentation/auth/getauthtoken.html
+      # @example receive the user token
+      #   KewegoParty.auth_get_auth_token
+      def auth_get_auth_token(options = {})
+        options = {:appToken => app_token, :username => self.login, :password => self.password}.merge options
+        response = get('/api/getAuthToken/', options, 2)
+        process_response(response, [:token])
+      end
+
+      # Generates a user token needed for adding and updating data in kewego
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :username(configuration.login). User name to login
+      # @option options [String] :password(configuration.password). Password to login
+      # @return [String] returns the user token
+      # @see http://developers.kewego.com/documentation/auth/getauthtoken.html
+      # @example receive the user token
+      #   KewegoParty.auth_get_login_token
+      def auth_get_login_token(options = {})
+        options = {:appToken => app_token, :username => self.login, :password => self.password}.merge options
+        response = get('/api/getLoginToken/', options, 2)
+        process_response(response, [:token])
+      end
+    end
+  end
+end

data/lib/kewego_party/client/channel.rb

@@ -0,0 +1,57 @@
+module KewegoParty
+  class Client
+    module Channel
+
+      def channel_get_videos(csig, options = {})
+        options = {:csig => csig, :appToken  => app_token}.merge options
+        response = get('/channel/getVideos/', options)
+        process_response(response, [])
+      end
+
+      def channel_get_details(csig, options = {})
+        options = {:csig => csig, :appToken  => app_token}.merge options
+        response = get('/channel/getDetails/', options)
+        process_response(response, [:channel])
+      end
+
+      # Thumbnail for a video
+      #
+      # @param csig [String] A Kewego channel Identifier.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :size (normal) Size of the thumbnail - Possible values: small/normal/large
+      # @option options [Integer] :pos (1) Position of the video in the channel
+      # @option options [Integer] :index (1) index of the thumbnail - Possible values: 1/2/3
+      # @return [String] A thumbnail
+      # @see http://developers.kewego_party.com/documentation/channel/getthumbnail.html
+      # @example receive a thumbnail from those available in the channel (csig)
+      #   KewegoParty.get_thumbnail("some_csig_identifier")
+      def channel_get_thumbnail(csig, options = {})
+        options = {:csig => csig, :appToken  => app_token}.merge options
+        get("/channel/getThumbnail/", options)
+      end
+
+      # Allows you to get the embedded code of a channel from the channel identifier (CSIG).
+      #
+      # @param csig [String] A Kewego channel Identifier.
+      # @param language_code [String] ('es') Language of the player
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :player_key
+      # @option options [String] :skin_key
+      # @option options [Boolean] :autostart
+      # @option options [String] :advertise
+      # @option options [Integer] :width (400)
+      # @option options [Integer] :height (300)
+      # @return [String] A Player embedded code
+      # @see http://developers.kewego.com/documentation/channel/getplayercode.html
+      # @example get the embedded code of a channel from the channel identifier (csig)
+      #   KewegoParty.get_player_code("some_csig_identifier")
+      def channel_get_player_code(csig, language_code = "es", options = {})
+        default_options = {:csig => csig, :appToken => app_token, :language_code => language_code}
+        options = default_options.merge options
+
+        response = get('/channel/getPlayerCode/', options)
+        process_response(response, [:blog])
+      end
+    end
+  end
+end

data/lib/kewego_party/client/channel_list.rb

@@ -0,0 +1,18 @@
+module KewegoParty
+  class Client
+    module ChannelList
+
+      def channel_list_get_channels(lsig, options = {})
+        options = {:start => 0, :max_result_per_page => 100, :lsig => lsig, :appToken  => app_token}.merge options
+        response = get("/channelList/getChannels/", options)
+        process_response(response, [:channels])
+      end
+
+      def channel_list_get_details(lsig)
+        options = {:lsig => lsig, :appToken  => app_token}
+        response = get("/channelList/getDetails/", options)
+        process_response(response, [])
+      end
+    end
+  end
+end

data/lib/kewego_party/client/upload.rb

@@ -0,0 +1,31 @@
+module KewegoParty
+  class Client
+    module Upload
+
+      # List of categories available for a video upload
+      #
+      # @return [Array] returns the available categories for a video upload.
+      # @see http://developers.kewego.com/documentation/upload/getavailablecategories.html
+      # @example receive the available categories
+      #   KewegoParty.upload_get_available_categories
+      def upload_get_available_categories
+        options = {:appToken  => app_token}
+        response = get("/upload/getAvailableCategories", options)
+        process_response(response, [:categories, :category])
+      end
+
+      # Status of a video upload
+      #
+      # @param upload_key [String] unique key used to follow an upload, declared in uploadVideo call as X-Progress-ID
+      # @return [Hashie::Rash] returns the status of the video upload
+      # @see http://developers.kewego.com/documentation/upload/getuploadprogress.html
+      # @example receive the status of an upload
+      #   KewegoParty.upload_get_upload_progress('cd26e3d0fd21fec2589c6f7dd41078')
+      def upload_get_upload_progress(upload_key)
+        options = {:appToken  => app_token, :upload_key => upload_key}
+        response = get("/upload/getUploadProgress", options)
+        process_response(response, [])
+      end
+    end
+  end
+end