yourub 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0017033502058c653e334a10a41c6185fdd90ef
-  data.tar.gz: 5c54a0c481cd6a1c2dc9807c1576b123efde2e1b
+  metadata.gz: 62dceba4187f657c56c4257e6b8694ea3cda1d28
+  data.tar.gz: e7b4c9de60739238e490380e6c0a94df15d25e73
 SHA512:
-  metadata.gz: 05c785075b9221f3c4cdad383af982d1f4ec3095a6a8023aeea0399ca5b648e29e0412d3e80fd28f2f37c5f357dcc0aed50d55102010988cbebf57c7ee54d106
-  data.tar.gz: 723d9580ebad77e7e7d27d9987307897aea7dda50f9695064f893f5a8ac6c06aa74523d8e23bdeaae0de1ef9f7c8306f08c4d62fb57a0de6ecb7a7813ba58c2e
+  metadata.gz: c83ec59e574c7d0fc9859a79bbf3035c81550461f01f93f4d6cd3be4184a5613974ac9f263ace49edb488007d11fdcc7954201437bc6bc08583fa78262fa7413
+  data.tar.gz: 020afea31419fa548e7fb11725e3fbceb489014f5c1e75758564ff54da4bac80f63e8599afe2b9bcf2ae1b86a9cdf2e7e65d5f9876c9577761e238078ec4b8c8

data/.gitignore

@@ -1,7 +1,8 @@
 *.gem
 *.rbc
+*.sublime-workspace
 .bundle
-.config
+.config/*
 .yardoc
 Gemfile.lock
 InstalledFiles

data/Gemfile

@@ -3,7 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in yourub.gemspec
 gemspec
 
-group :development, :test do
-  gem "debugger"
-  gem "pry"
-end
+# group :development, :test do
+#   	gem "byebug"
+# end

data/README.md

@@ -1,8 +1,7 @@
 [![Code Climate](https://codeclimate.com/github/edap/yourub.png)](https://codeclimate.com/github/edap/yourub)
 
 # Yourub
-
-Yourub is a gem that parse the Youtube API. It is possible to look for a given nation, a category, a given video ID or searching by the of views. It's updated to the version 3 of the youtube api
+Yourub is a gem that search videos on youtebe using the YouTube API v3.
 
 ## Installation
 
@@ -31,47 +30,60 @@ If you are using rails, create a app/config/yourub.yml file as follow:
       application_version: "version_number_of_your_app"
       log_level: WARN
 
-As default beahviour, the Yourub gem retrieve 2 videos for each category for the default country, USA.
-
-    result = Yourub::Search.new()
-    result.categories
-    result.videos
-
-
-Actually, is possible to select videos for a given country specifying the nation parameter (equivalent to the regionCode on the native youtube API) The parameter value is an [ISO 3166-1](http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm) alpha-2 country code.
-
-    Yourub::Search.new(nation: "IT")
-
-
-for a given category
-
-    Yourub::Search.new(category: "Sports")
-
-
-to filter out videos depending on the number of views that they have
-
-    filter = {'views' => ">= 1000"}
-    Yourub::Search.new(filter: filter)
-
-
-to set the max number of videos for each nation/category request (max 50, default 2)
-
-    result = Yourub::Search.new(max_results: 25)
-
-Or all the options together
-
-    filter = {'views' => "<= 200"}
-    Yourub::Search.new(nation: "FR", category: "Comedy", max_results: 25, filter: filter)
-
-To get all the available metatags for a single video, simply give the Youtube video id as parameter
-
-    Yourub::Search.new(video_id: "mN0Dbj-xHY0")
+### Available parameters
+`:query` String, example `aliens`
+`:id` Sting, a valid youtube video id, example `NisCkxU544c`. If this parameter is set, tha others are ignored
+`:country` String, one or more alpha-2 country codes [ISO 3166-1](http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm), example `US` or `IT, DE`
+`:category` String, example `comedy`
+`:count_filters` Hash, example `{views: ">= 100"}` or `{views: "== 600"}`
+`:max_results` Integer, between 1 and 50
+
+It's necessary at least one of this parameters to start a search: `:country`, `:category`, `:query`, `:id`
+ 
+### Examples
+
+For example, to find videos in the category "sports" in the country "de"
+```ruby
+client = Yourub::Client.new
+client.search(country: "DE", category: "sports")
+client.videos
+```
+
+To find video for a specific thema, use the parameter query
+
+```ruby
+client = Yourub::Client.new
+client.search(query: "aliens")
+client.videos
+```
+
+### Extend Info
+As default Yourub will give you back few values, example:
+
+```ruby
+client = Yourub::Client.new
+client.search(id: "mN0Dbj-xHY0")
+```
+will report id, title, the default thumb, and the url where you can watch the video
+```
+[{"id"=>"mN0Dbj-xHY0", "title"=>"GoPro: Hiero Day", "thumb"=>"https://i1.ytimg.com/vi/mN0Dbj-xHY0/default.jpg", "url"=>"https://www.youtube.com/watch?v=mN0Dbj-xHY0"}]
+```
+
+To have more values back, use the option `extended_info`
+```ruby
+client = Yourub::Client.new
+client.extended_info = true
+client.search(id: "NisCkxU544c")
+```
+It will give you back much more information
+```
+[{"kind"=>"youtube#video", "etag"=>"\"N5Eg36Gl054SUNiWWc-Su3t5O-k/U6AzLXvcnZt2WFqpnq9_dksV7DA\"", "id"=>"NisCkxU544c", "snippet"=>{"publishedAt"=>"2009-04-05T05:20:10.000Z", "channelId"=>"UCCHcEUksSVKsRDH86j77Ntg", "title"=>"Like A Boss (ft. Seth Rogen) - Uncensored Version", "description"=>"http://www.itunes.com/thelonelyisland\r\n\r\nThe new single from The Lonely Island's debut album \"INCREDIBAD\" In stores now!\r\n\r\nFeaturing Seth Rogen.\r\n\r\nThe Lonely Island is Andy Samberg, Akiva Schaffer & Jorma Taccone.", "thumbnails"=>{"default"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/default.jpg", "width"=>120, "height"=>90}, "medium"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/mqdefault.jpg", "width"=>320, "height"=>180}, "high"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/hqdefault.jpg", "width"=>480, "height"=>360}, "standard"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/sddefault.jpg", "width"=>640, "height"=>480}, "maxres"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/maxresdefault.jpg", "width"=>1280, "height"=>720}}, "channelTitle"=>"thelonelyisland", "categoryId"=>"23", "liveBroadcastContent"=>"none"}, "statistics"=>{"viewCount"=>"120176425", "likeCount"=>"594592", "dislikeCount"=>"15121", "favoriteCount"=>"0", "commentCount"=>"208109"}}]
+```
 
 ##TODO
 
-1. filter by search term
-2. move nation, category and max result in the filter options
-3. adding a CLI
+1. adding a CLI
+2. add `:order` in the search criteria
 
 ## Contributing
 

data/README.md~

@@ -0,0 +1,91 @@
+[![Code Climate](https://codeclimate.com/github/edap/yourub.png)](https://codeclimate.com/github/edap/yourub)
+
+# Yourub
+Yourub is a gem that search videos on youtebe using the YouTube API v3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yourub'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yourub
+
+## Usage
+
+Get a developer key as explained [here](http://www.youtube.com/watch?v=Im69kzhpR3I)
+If you are using rails, create a app/config/yourub.yml file as follow:
+
+    yourub:
+      developer_key: 'yourdeveloperkey'
+      youtube_api_service_name: 'youtube'
+      youtube_api_version: 'v3'
+      application_name: "nameofyourapp"
+      application_version: "version_number_of_your_app"
+      log_level: WARN
+
+### Available parameters
+`:query` String, example `aliens`
+`:id` Sting, a valid youtube video id, example `NisCkxU544c`. If this parameter is set, tha others are ignored
+`:country` String, one or more alpha-2 country codes [ISO 3166-1](http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm), example `US` or `IT, DE`
+`:category` String, example `comedy`
+`:count_filters` Hash, example `{views: ">= 100"}` or `{views: "== 600"}`
+`:max_results` Integer, between 1 and 50
+
+It's necessary at least one of this parameters to start a search: `:country`, `:category`, `:query`, `:id`
+ 
+### Examples
+
+For example, to find videos in the category "sports" in the country "de"
+```ruby
+client = Yourub::Client.new
+client.search(country: "DE", category: "sports")
+client.videos
+```
+
+To find video for a specific thema, use the parameter query
+
+```ruby
+client = Yourub::Client.new
+client.search(query: "aliens")
+client.videos
+```
+
+### Extend Info
+As default Yourub will give you back few values, example:
+
+```ruby
+client = Yourub::Client.new
+client.search(id: "mN0Dbj-xHY0")
+```
+will report id, title, the default thumb, and the url where you can watch the video
+[{"id"=>"mN0Dbj-xHY0", "title"=>"GoPro: Hiero Day", "thumb"=>"https://i1.ytimg.com/vi/mN0Dbj-xHY0/default.jpg", "url"=>"https://www.youtube.com/watch?v=mN0Dbj-xHY0"}]
+```
+
+To have more values back, use the option `extended_info`
+```ruby
+client = Yourub::Client.new
+client.extended_info = true
+client.search(id: "NisCkxU544c")
+[{"kind"=>"youtube#video", "etag"=>"\"N5Eg36Gl054SUNiWWc-Su3t5O-k/U6AzLXvcnZt2WFqpnq9_dksV7DA\"", "id"=>"NisCkxU544c", "snippet"=>{"publishedAt"=>"2009-04-05T05:20:10.000Z", "channelId"=>"UCCHcEUksSVKsRDH86j77Ntg", "title"=>"Like A Boss (ft. Seth Rogen) - Uncensored Version", "description"=>"http://www.itunes.com/thelonelyisland\r\n\r\nThe new single from The Lonely Island's debut album \"INCREDIBAD\" In stores now!\r\n\r\nFeaturing Seth Rogen.\r\n\r\nThe Lonely Island is Andy Samberg, Akiva Schaffer & Jorma Taccone.", "thumbnails"=>{"default"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/default.jpg", "width"=>120, "height"=>90}, "medium"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/mqdefault.jpg", "width"=>320, "height"=>180}, "high"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/hqdefault.jpg", "width"=>480, "height"=>360}, "standard"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/sddefault.jpg", "width"=>640, "height"=>480}, "maxres"=>{"url"=>"https://i1.ytimg.com/vi/NisCkxU544c/maxresdefault.jpg", "width"=>1280, "height"=>720}}, "channelTitle"=>"thelonelyisland", "categoryId"=>"23", "liveBroadcastContent"=>"none"}, "statistics"=>{"viewCount"=>"120176425", "likeCount"=>"594592", "dislikeCount"=>"15121", "favoriteCount"=>"0", "commentCount"=>"208109"}}]
+```
+
+
+##TODO
+
+1. adding a CLI
+2. add `:order` in the search criteria
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/yourub/client.rb

@@ -0,0 +1,184 @@
+module Yourub
+  class Client
+
+    attr_reader :videos
+    attr_accessor :config, :extended_info
+
+    def initialize()
+      @extended_info = false
+      @categories, @videos = [], []
+      @api_options= {
+        :part            => 'snippet',
+        :type            => 'video',
+        :eventType       => 'completed',
+        :order           => 'date',
+        :safeSearch      => 'none',
+      }
+    end
+
+    def config
+      Yourub::Config
+    end
+
+    def client
+      @client ||= Google::APIClient.new(
+        :key => config.developer_key,
+        :application_name => config.application_name,
+        :application_version => config.application_version,
+        :authorization => nil,
+      )
+    end
+
+    def youtube
+      @youtube ||= client.discovered_api(config.youtube_api_service_name,
+        config.youtube_api_version)
+    end
+
+    def search(criteria)
+      begin
+        @videos = []
+        @criteria = Yourub::Validator.confirm(criteria)
+        search_by_criteria
+      rescue ArgumentError => e
+        Yourub.logger.error "#{e}"
+      end
+    end
+
+    def search_by_criteria
+      if @criteria.has_key? :id
+        search_by_id
+      else
+        merge_criteria_with_api_options
+        retrieve_categories
+        retrieve_videos
+      end
+    end
+
+    def search_by_id
+      params = {
+        :id => @criteria[:id],
+        :part => 'snippet,statistics',
+      }
+      video_response = client.execute!(
+        :api_method => youtube.videos.list,
+        :parameters => params
+      )
+      entry = Yourub::Reader.parse_videos(video_response).first
+      add_video_to_search_result(entry) unless entry.nil?
+    end
+
+    def merge_criteria_with_api_options
+      mappings = {query: :q, max_results: :maxResults, country: :regionCode}
+      @api_options.merge! @criteria
+      @api_options.keys.each do |k| 
+        @api_options[ mappings[k] ] = @api_options.delete(k) if mappings[k] 
+      end
+    end
+
+    def retrieve_categories
+      if @criteria.has_key? :category
+        get_categories_for_country(@criteria[:country])
+        @categories = Yourub::Validator.valid_category(@categories, @criteria[:category])
+      end
+    end
+
+    def get_categories_for_country(country)
+      categories_list = video_categories_list_request(country)
+      categories_list.data.items.each do |cat_result|
+        category_name = parse_name(cat_result["snippet"]["title"])
+        @categories.push(cat_result["id"] => category_name)
+      end
+    end
+
+    def retrieve_videos
+      consume_criteria do |criteria|
+        req = search_list_request(criteria)
+        if @extended_info || @criteria[:count_filter]
+          get_details_and_store req
+        else
+          videos = Yourub::Reader.parse_videos(req)
+          videos.each{|v| add_video_to_search_result(v) }
+        end
+      end
+    end
+
+    def consume_criteria
+      to_consume = @api_options
+      if @criteria[:country]
+        @criteria[:country].each do |country|
+          to_consume[:regionCode] = country
+          consume_categories(to_consume) do |cat|
+            yield cat
+          end
+        end
+      else
+        yield to_consume
+      end
+    end
+
+    def consume_categories(to_consume)
+      if @categories.size > 0
+        @categories.each do |cat|
+          to_consume[:videoCategoryId] = cat.keys[0].to_i
+          yield to_consume
+        end
+      else
+        yield to_consume
+      end    
+    end
+
+    def get_details_and_store(video_list)
+      video_list.data.items.each do |video_item|
+        v = videos_list_request video_item.id.videoId
+        v = Yourub::Reader.parse_videos(v).first
+        add_video_to_search_result(v)
+      end
+    end
+
+    def search_list_request(options)
+      search_response = client.execute!(
+        :api_method => youtube.search.list, 
+        :parameters => options
+      )
+    end
+
+    def videos_list_request(result_video_id)
+      params = video_params(result_video_id)
+      video_response = client.execute!(
+        :api_method => youtube.videos.list,
+        :parameters => params
+      )
+    end
+
+    def video_categories_list_request(country)
+      categories_list = client.execute!(
+        :api_method => youtube.video_categories.list,
+        :parameters => {"part" => "snippet","regionCode" => country }
+      )
+    end
+
+    def video_params(result_video_id)
+      parameters = {
+        :id => result_video_id,
+        :part => 'snippet,statistics,id',
+      }
+      unless @extended_info
+        fields = 'items(id,snippet(title,thumbnails),statistics(viewCount))'
+        parameters[:fields] = URI::encode(fields)
+      end
+      return parameters
+    end
+
+    def add_video_to_search_result(entry)
+      video = @extended_info ? entry : Yourub::Reader.parse_entry(entry)
+      if Yourub::CountFilter.accept?(entry, @criteria[:count_filter])
+        @videos.push(video)
+      end
+    end
+
+    def parse_name(name)
+      return name.gsub("/", "-").downcase.gsub(/\s+/, "")
+    end
+
+  end
+end

data/lib/yourub/reader.rb

@@ -0,0 +1,19 @@
+module Yourub
+  module Reader
+    class << self
+      def parse_videos(videos)
+        JSON.parse(videos.data.to_json)['items']
+      end
+
+      def parse_entry(entry)
+        video_id = entry["id"]["videoId"] || entry['id']
+        founded_video = {
+           'id'    => video_id,
+           'title' => entry['snippet']['title'],
+           'thumb' => entry['snippet']['thumbnails']['default']['url'],
+           'url'   => 'https://www.youtube.com/watch?v='<< video_id
+        }
+      end
+    end
+  end
+end

data/lib/yourub/validator.rb

@@ -0,0 +1,92 @@
+module Yourub
+  module Validator
+    class << self
+      #attr_reader :videos, :countrys, :categories
+
+      DEFAULT_COUNTRY = "US" #if not given, a country it's necessary to retrieve a categories list
+      COUNTRIES = [
+        'AR','AU','AT','BE','BR','CA','CL','CO','CZ','EG','FR','DE','GB','HK',
+        'HU','IN','IE','IL','IT','JP','JO','MY','MX','MA','NL','NZ','PE','PH',
+        'PL','RU','SA','SG','ZA','KR','ES','SE','CH','TW','AE','US']
+
+      VALID_PARAMS   = [:country, :category, :query, :id, :max_results, :count_filter]
+      MINIMUM_PARAMS = [:country, :category, :query, :id]
+
+      def confirm(criteria)
+        @criteria = criteria
+        valid_format?
+        remove_empty_and_non_valid_params
+        minimum_param_present?
+
+        keep_only_the_id_if_present
+        countries_to_array
+        add_default_country_if_category_is_present
+        validate_countries
+
+        @criteria
+      end
+
+      def remove_empty_and_non_valid_params
+        @criteria.keep_if{|k,v| ( (VALID_PARAMS.include? k) && (v.size > 0)) }
+      end
+
+      def keep_only_the_id_if_present
+        if @criteria.has_key? :id
+          @criteria.keep_if{|k, _| k == :id}
+        end
+      end
+
+      def countries_to_array
+        if @criteria.has_key? :country
+          @criteria[:country] = @criteria[:country].split(',').collect(&:strip)
+        end
+      end
+
+      def add_default_country_if_category_is_present
+        if (@criteria.has_key? :category) && (!@criteria.has_key? :country)
+          @criteria[:country] = [ DEFAULT_COUNTRY ]
+        end
+      end
+
+      def valid_category(categories, selected_category)
+        categories = categories.select {|k| k.has_value?(selected_category.downcase)}
+        if categories.first.nil?
+          raise ArgumentError.new(
+            "The category #{selected_category} does not exists in the following ones: #{categories.join(',')}")
+        end
+        return categories
+      end
+
+      def valid_format?
+        raise ArgumentError.new(
+          "give an hash as search criteria"
+        ) unless( @criteria.is_a? Hash )
+      end
+
+      def minimum_param_present?  
+        if @criteria.none?{|k,_| MINIMUM_PARAMS.include? k}
+        raise ArgumentError.new(
+          "minimum params to start a search is at least one of: #{MINIMUM_PARAMS.join(',')}"
+        )
+        end
+      end
+
+      def validate_countries
+        if @criteria.has_key? :country
+          raise ArgumentError.new(
+            "the given country is not in the available ones: #{COUNTRIES.join(',')}"
+          ) unless( (@criteria[:country] & COUNTRIES).size > 0 )
+        end
+      end
+
+      def validate_max_results
+        raise ArgumentError.new(
+          'max 50 videos pro categories or country'
+        ) unless(
+          @criteria[:max_results].to_i < 50 || @criteria[:max_results].to_i == 0
+        )
+      end
+
+    end
+  end
+end

data/lib/yourub/version.rb

@@ -1,3 +1,6 @@
 module Yourub
-  VERSION = "0.1.1"
+  MAJOR = 1
+  MINOR = 0
+  PATCH = 0
+  VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
 end

data/lib/yourub.rb

@@ -5,10 +5,12 @@ require 'open-uri'
 require 'google/api_client'
 
 require 'yourub/config'
+require 'yourub/client'
 require 'yourub/version'
 require 'yourub/logger'
 require 'yourub/count_filter'
-require 'yourub/search'
+require 'yourub/validator'
+require 'yourub/reader'
 
 if defined?(Rails)
   require 'yourub/railtie'

data/spec/client_spec.rb

@@ -0,0 +1,57 @@
+require 'yourub'
+
+describe Yourub::Client do
+
+  context "on initialize" do
+    let(:subject) { Yourub::Client.new }
+
+    it "return an error if the given country does not exist" do
+      subject.search(country: "MOON")
+      expect(lambda{subject}).not_to raise_error()
+    end
+
+    it "retrieves more infos with the option extended_info = true" do
+      filter = {views: ">= 100"}
+      subject.extended_info = true
+      subject.search(country: "US", category: "Sports", count_filter: filter)
+      expect(subject.videos.first.has_key? "statistics").to be_true
+    end   
+
+    it "retrieves videos that have more than 100 views" do
+      filter = {views: ">= 100"}
+      subject.search(country: "US", category: "Sports", count_filter: filter)
+      expect(subject.videos).to be_a_kind_of(Array)
+    end
+
+    it "retrieves 5 videos for each given category" do
+      subject.search(country: "US, DE", category: "Sports", max_results: 5)
+      expect(subject.videos.count).to eq(10)
+    end
+
+    it "retrieves the given number of video for the given category" do
+      subject.search(category: "Sports", max_results: 2)
+      expect(subject.videos.count).to eq(2)
+    end  
+
+    it "retrieves the given number of video for the given word" do
+      subject.search(query: "casa", max_results: 3)
+      expect(subject.videos.count).to eq(3)
+    end    
+
+    it "retrieves the given number of video for the given country" do
+      subject.search(country: "US", max_results: 5)
+      expect(subject.videos.count).to eq(5)
+    end
+
+    it "retrieves a video for the given id" do
+      subject.search(id: "mN0Dbj-xHY0")
+      expect(subject.videos.first["id"]).to eql("mN0Dbj-xHY0")
+    end
+
+    it "return nil for a not existing video" do
+      subject.search(id: "fffffffffffffffffffff")
+      expect(subject.videos).to be_empty
+    end
+  end
+
+end