yourub 0.1.1 → 1.0.0

data/spec/validator_spec.rb

@@ -0,0 +1,94 @@
+require 'yourub'
+
+describe Yourub::Validator do
+  let(:subject) { Yourub::Validator.confirm(criteria) }
+
+  context "passing an hash containing the search criteria" do
+    context "with some valid criteria" do
+      context "with valid nation but unknown parameter city" do
+        let(:criteria) { {country: 'US', city: 'Berlin'} }
+        it "return criteria including nation but excluding the city" do
+          expect(subject).to eq({country: ['US']})
+        end
+      end
+
+      context "with a given category without a country" do
+        let(:criteria) { {country: '', category: 'Sport'} }
+        it "add the default country" do
+          expect(subject).to eq({category: 'Sport', :country=>["US"]})
+        end
+      end
+
+      context "with all the available parameters present" do
+        let(:criteria) { {country: 'IT', 
+                          category: 'Sport', 
+                          max_results: 2, 
+                          count_filter: {}, 
+                          query: '', 
+                          id: ''} }
+        it "return only them params that has a value" do
+          expect(subject).to eq({country: ["IT"], category: 'Sport', max_results: 2 })
+        end
+      end
+
+      context "when the parameter 'id' is set" do
+        let(:criteria) { {country: 'US', id: '1111111111'} }
+        it "ignore the other params and leave only the id" do 
+          expect(subject).to eq({ id: '1111111111' })
+        end
+      end
+    end
+
+    context "if none of the criteria are valid" do
+      context "with non valid criteria" do
+        let(:criteria) { {big: 1, bang: 2} }
+        it 'raise an argument error' do
+          expect(lambda{subject}).to raise_error(ArgumentError)
+        end
+      end
+
+      context "with criteria in the wrong format, like a string" do
+        let(:criteria) { "country = US" }
+        it 'raise an argument error' do
+          expect(lambda{subject}).to raise_error(ArgumentError)
+        end
+      end
+
+      context "with an invalid country" do
+        let(:criteria) { {country: 'MOON'} }
+        it 'raise an argument error' do
+          expect(lambda{subject}).to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    context "with valid criteria but not enough to start a search" do
+      context "only with maximum and count filter" do
+        let(:criteria) { {max_results: 10, count_filter: {views: ">= 100"}} }
+        it 'raise an argument error' do
+          expect(lambda{subject}).to raise_error(ArgumentError)
+        end
+      end
+    end    
+  end
+
+  context "passing a list of available categories and the selected one" do
+    let(:subject) { Yourub::Validator.valid_category(categories, selected_one) }
+    let(:categories) { [{"10"=>"music"}, {"15"=>"pets&animals"}, {"17"=>"sports"}, {"18"=>"shortmovies"}] }
+
+    context "with an invalid category" do
+      let(:selected_one) { "spaghetti" }
+      it 'raise an argument error' do
+        expect(lambda{subject}).to raise_error(ArgumentError)
+      end
+    end
+
+    context "with a valid category" do
+      let(:selected_one) { "sports" }
+      it 'return it' do
+        expect(subject.first.has_value? "sports").to be_true
+      end
+    end
+  end
+
+end

data/yourub.gemspec

@@ -10,8 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["lastexxit@gmail.com "]
   spec.description   = %q{Youtube API v3 parser}
   spec.summary       = %q{Yourub is a gem that fetch the most recent videos from
-                       the Youtube API for the given nation, category and number
-                       of views}
+                       the Youtube API for the given criteria}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -22,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "google-api-client"
 
   spec.add_development_dependency "rspec", "~> 2.14"

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: yourub
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Davide Prati
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-20 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: google-api-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
 description: Youtube API v3 parser
@@ -88,27 +102,30 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
+- README.md~
 - Rakefile
 - bin/yourub
 - config/yourub.yml
 - lib/yourub.rb
 - lib/yourub/cli.rb
+- lib/yourub/client.rb
 - lib/yourub/config.rb
 - lib/yourub/count_filter.rb
 - lib/yourub/default.rb
 - lib/yourub/logger.rb
 - lib/yourub/railtie.rb
-- lib/yourub/search.rb
+- lib/yourub/reader.rb
+- lib/yourub/validator.rb
 - lib/yourub/version.rb
+- spec/client_spec.rb
 - spec/count_filter_spec.rb
-- spec/search_spec.rb
+- spec/validator_spec.rb
 - yourub.gemspec
 - yourub.sublime-project
-- yourub.sublime-workspace
 homepage: ''
 licenses:
 - MIT
@@ -119,21 +136,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0.rc.1
 signing_key: 
 specification_version: 4
 summary: Yourub is a gem that fetch the most recent videos from the Youtube API for
-  the given nation, category and number of views
+  the given criteria
 test_files:
+- spec/client_spec.rb
 - spec/count_filter_spec.rb
-- spec/search_spec.rb
+- spec/validator_spec.rb

data/lib/yourub/search.rb

@@ -1,178 +0,0 @@
-module Yourub
-  class Search
-
-      attr_reader :videos, :nations, :categories
-      attr_accessor :config
-
-      def initialize(nation: "US", category: 'all', max_results: 2, video_id: nil, filter: nil)
-        local_variables.each do |k|
-          v = eval(k.to_s)
-          instance_variable_set("@#{k}", v) unless v.nil?
-        end
-
-        valid?
-        @extended_video_info = false
-        @categories, @videos = [], []
-        @options = default_search_video_options
-
-        starting_search
-      end
-
-      def config
-        Yourub::Config
-      end
-
-      def starting_search
-        unless @video_id.nil?
-          @extended_video_info = true
-          return video_info_request @video_id
-        end
-        retrieve_categories
-        retrieve_videos
-      end
-
-      NATIONS = [
-        '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']
-
-      def valid?
-        validate_nation
-        validate_max_results
-      end
-
-      def validate_nation
-        raise ArgumentError.new('params not available') unless(
-          NATIONS.include?(@nation)
-        )
-      end
-
-      def validate_max_results
-        raise ArgumentError.new('max 50 videos pro categories or nation') unless(
-          @max_results.to_i < 50 || @max_results.to_i == 0
-        )
-      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 categories_request
-        categories_list = client.execute!(
-          :api_method => youtube.video_categories.list,
-          :parameters => {"part" => "snippet","regionCode" => @nation }
-        )
-      end
-
-      def retrieve_categories
-        retrieve_all_categories
-        if @category != 'all'
-          retrieve_only_one_category
-        end
-      end
-
-      def retrieve_all_categories
-        categories_request.data.items.each do |cat_result|
-          @categories.push(cat_result["id"] => cat_result["snippet"]["title"])
-        end
-      end
-
-      def retrieve_only_one_category
-        @categories = @categories.select {|k| k.has_value?(@category)}
-        if @categories.first.nil?
-          raise ArgumentError.new('The category #{@category} does not exists')
-        end
-      end
-
-      def default_search_video_options
-        opt = {
-          :maxResults      => @max_results,
-          :regionCode      => @nation,
-          :type            => 'video',
-          :order           => 'date',
-          :safeSearch      => 'none'
-          #:videoCategoryId => '10'
-        }
-      end
-
-      def retrieve_videos
-        #@nations.each do |nat|
-          @categories.each do |cat|
-            @options[:videoCategoryId] = cat.keys[0].to_i
-            #@options[:regionCode] = nat
-            @options[:part] = 'id'
-            read_response videos_list_request
-          end
-        #end
-      end
-
-      def read_response(video_list)
-        video_list.data.items.each do |video_item|
-          video_info_request video_item.id.videoId
-        end
-      end
-
-      def videos_list_request
-        search_response = client.execute!(
-          :api_method => youtube.search.list,
-          :parameters => @options
-        )
-      end
-
-      def video_info_request(result_video_id)
-        params = video_params(result_video_id)
-        video_response = client.execute!(
-          :api_method => youtube.videos.list,
-          :parameters => params
-        )
-        store_video(result_video_id, video_response)
-      end
-
-      def video_params(result_video_id)
-        parameters = {
-          :id => result_video_id,
-          :part => 'snippet,statistics',
-        }
-        unless @extended_video_info
-          fields = 'items(snippet(title,thumbnails),statistics(viewCount))'
-          parameters[:fields] = URI::encode(fields)
-        end
-        return parameters
-      end
-
-      def add_video_to_search_result(entry, video_id)
-        if @extended_video_info
-          founded_video = entry
-        else
-          founded_video = {
-             'title' => entry['snippet']['title'],
-             'url' => 'https://www.youtube.com/watch?v='<< video_id
-          }
-        end
-         @videos.push(founded_video)
-      end
-
-      def store_video(video_id, video_response)
-        begin
-          result = JSON.parse(video_response.data.to_json)
-          entry = result['items'].first
-          if Yourub::CountFilter.accept?(entry, @filter)
-            add_video_to_search_result(entry, video_id)
-          end
-        rescue StandardError => e
-          Yourub.logger.error "Error #{e} reading the video stream"
-        end
-      end
-
-  end
-end

data/spec/search_spec.rb

@@ -1,52 +0,0 @@
-require 'yourub'
-
-describe Yourub::Search do
-
-  context "on initialize" do
-    # it "retrieves all the available categories for the default country" do
-    #   result = Yourub::Search.new()
-    #   expect(result.categories).to be_a_kind_of(Array)
-    # end
-
-    # it "retrieves all the available categories for a given country" do
-    #   result = Yourub::Search.new(nation: "US")
-    #   expect(result.categories).to be_a_kind_of(Array)
-    # end
-
-    it "return an error if the given country does not exists" do
-      expect{ Yourub::Search.new(nation: "MOON") }.to raise_error(ArgumentError)
-    end
-
-    it "return an error if the given category does not exists" do
-      expect{ Yourub::Search.new(nation: "US", category: "Puzzles") }.to raise_error
-    end
-
-    it "initialize the instance variabe @category with the given category" do
-      result = Yourub::Search.new(nation: "US", category: "Sports")
-      expect(result.categories.first.values).to include("Sports")
-      expect(result.categories.first.key("Sports").to_i).to be_a_kind_of(Integer)
-    end
-
-    it "retrieves 2 videos pro category if no max_results is specified" do
-      result = Yourub::Search.new(nation: "US", category: "Sports")
-      expect(result.videos.count).to eq(2)
-    end
-
-    it "retrieves 5 videos pro category max_results = 5" do
-      result = Yourub::Search.new(nation: "US", category: "Sports", max_results: 5)
-      expect(result.videos.count).to eq(5)
-    end
-
-    it "retrieves videos that have more than 100 views" do
-      filter = {views: ">= 100"}
-      result = Yourub::Search.new(nation: "US", category: "Sports", max_results: 5, filter: filter)
-      expect(result.videos).to be_a_kind_of(Array)
-    end
-
-    it "retrieves a video for the given id" do
-      result = Yourub::Search.new(video_id: "mN0Dbj-xHY0")
-      expect(result.videos.count).to eq(1)
-    end
-  end
-
-end