yourub 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a837f36e2f88084e6c3cef0ebf1ae93bf2bb856
-  data.tar.gz: a65082a176e99de6ef63b21faf295b7f0aea3c50
+  metadata.gz: 50484cd54ec618de42e1bc3159c5d38b2926f66d
+  data.tar.gz: 0bd8f7e973ee94ddf8a55d8be05a7165c795c519
 SHA512:
-  metadata.gz: 4dda7c152233c2997df0a41d9f55f539132f0cee15c1e81a7eb5f7f9d265f548e302771825a534b67e402c07e18afd3346d64eac6e4c69620a68ea1a7add178b
-  data.tar.gz: d107046ec38b048343ff2825ed1e2c208c7a1c7bb2ef21514876f7f3affb0337256f1c49ad2d4a804b8c1d638beaf7cbac9834183b031ff5465548285c27d08a
+  metadata.gz: 55da616aafeb6704d14d99d7f09f545088a2b780cd9334019fb67befd0f792e83e792aeee6c9b04cc66f34ec4a0bc1598eda34e477204b87f061a1c567671681
+  data.tar.gz: 46516c6624186015d2f0590dc6e40f107f2a80f6fe4bd8551e4cf4843f6c15cc53567d89463eaef04d21ffae1d55ff6c7bed6f0050d5063199ae86b8d2100e66

data/README.md

@@ -43,14 +43,16 @@ If you are using rails, create a app/config/yourub.yml file as follow:
 
 `:max_results` Integer, between 1 and 50
 
+`:order` String, one of these: 'date', 'rating', 'relevance', 'title', 'videocount', 'viewcount'. The default one is `'relevance'`
+
 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"
+For example, to find the most recent videos in the category "sports" in Germany
 ```ruby
 client = Yourub::Client.new
-client.search(country: "DE", category: "sports")
+client.search(country: "DE", category: "sports", order: 'date')
 client.videos
 ```
 
@@ -88,7 +90,6 @@ It will give you much more information
 ##TODO
 
 1. adding a CLI
-2. add `:order` in the search criteria
 
 ## Contributing
 

data/lib/yourub/client.rb

@@ -11,7 +11,7 @@ module Yourub
         :part            => 'snippet',
         :type            => 'video',
         :eventType       => 'completed',
-        :order           => 'date',
+        :order           => 'relevance',
         :safeSearch      => 'none',
       }
     end
@@ -140,6 +140,7 @@ module Yourub
     end
 
     def search_list_request(options)
+      byebug
       search_response = client.execute!(
         :api_method => youtube.search.list, 
         :parameters => options

data/lib/yourub/validator.rb

@@ -2,22 +2,23 @@ module Yourub
   module Validator
     class << self
 
-      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]
+      DEFAULT_COUNTRY = "US"
+      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']
+      ORDERS          = ['date', 'rating', 'relevance', 'title', 'videocount', 'viewcount']
+      VALID_PARAMS    = [:country, :category, :query, :id, :max_results, :count_filter, :order]
+      MINIMUM_PARAMS  = [:country, :category, :query, :id]
 
       def confirm(criteria)
         valid_format?(criteria)
         @criteria = symbolize_keys(criteria)
+
         remove_empty_and_non_valid_params
         minimum_param_present?
 
         keep_only_the_id_if_present
+        validate_order
         countries_to_array
         add_default_country_if_category_is_present
         validate_countries
@@ -25,10 +26,6 @@ module Yourub
         @criteria
       end
 
-      def available_countries
-        COUNTRIES
-      end
-
       def symbolize_keys(hash)
         hash.inject({}){|result, (key, value)|
           new_key = case key
@@ -89,6 +86,14 @@ module Yourub
         end
       end
 
+      def validate_order
+        if @criteria.has_key? :order
+          raise ArgumentError.new(
+            "the given order is not in the available ones: #{ORDERS.join(',')}"
+          ) unless( ORDERS.include? @criteria[:order] )    
+        end
+      end
+
       def validate_countries
         if @criteria.has_key? :country
           raise ArgumentError.new(
@@ -105,6 +110,9 @@ module Yourub
         )
       end
 
+      def available_countries
+        COUNTRIES
+      end
     end
   end
 end

data/lib/yourub/version.rb

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

data/spec/client_spec.rb

@@ -27,6 +27,11 @@ describe Yourub::Client do
       expect(subject.videos).to be_a_kind_of(Array)
     end
 
+    it "accept an 'order' parameter within the others" do
+      subject.search(country: "US", category: "Sports", order: 'date')
+      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)

data/spec/validator_spec.rb

@@ -8,7 +8,7 @@ describe Yourub::Validator do
 
       context "no matter if the crteria has old 'key' => 'val' or key: val sintax" do
         let(:criteria) { {"country" => 'US', "category" => 'Sport'} }
-        it "return criteria including nation but excluding the city" do
+        it "return the criteria in the sym: val format" do
           expect(subject).to eq({country: ['US'], category: 'Sport'})
         end
       end
@@ -20,6 +20,13 @@ describe Yourub::Validator do
         end
       end
 
+      context "with an invalid :order value" do
+        let(:criteria) { {order: 'banane', query: 'roberto baggio'} }
+        it 'raise an argument error' do
+          expect(lambda{subject}).to raise_error(ArgumentError)
+        end
+      end
+
       context "with a given category without a country" do
         let(:criteria) { {country: '', category: 'Sport'} }
         it "add the default country" do

data/yourub.gemspec

@@ -10,7 +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 search videos on youtebe using the YouTube API v3}
-  spec.homepage      = "http://edapx.com"
+  spec.homepage      = "https://github.com/edap/yourub"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.1"
   spec.add_development_dependency "rspec", "~> 2.14"
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yourub
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Davide Prati
@@ -111,7 +111,7 @@ files:
 - spec/validator_spec.rb
 - yourub.gemspec
 - yourub.sublime-project
-homepage: http://edapx.com
+homepage: https://github.com/edap/yourub
 licenses:
 - MIT
 metadata: {}