active_public_resources 0.1.4 → 0.2.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDA3ZjczNDA1MmRjMDhiMzdkNzMwNDkyY2I4NjZmZmMwNGFmN2YxYQ==
-  data.tar.gz: !binary |-
-    NDliYWYzMjQ3NmM0ZDIxOTA4NThlOTJmNTE3NjEwYTY4MDMyYzM5ZQ==
+SHA1:
+  metadata.gz: 4e99a0eb62cafe3e34b5871ca70220f4b3270e6d
+  data.tar.gz: c838fe9798d6c23af9d4aa265d95c8aac22bcf67
 SHA512:
-  metadata.gz: !binary |-
-    Yzk1Njk5MmY3NDhlY2U3MDFkMmNmZjQxZmI2Njk3ZWZhNzM1NjY0ZDA1NGNl
-    MWY3ODM3Y2JiY2Q5OTFmODY2MWJkMTRiYjk0OWRiZTUxYmU4ZWRiMjExNjkw
-    NTNhYmYxMGU2MTg5YmVhZmRmNzE5NTExNzYxNGZiMzExNWQ2YjM=
-  data.tar.gz: !binary |-
-    Yjk3MjFmMDY2MWI4YTcyYWYzMWJiNDZkNWVjZmUyN2YxNzgyY2Q0NzZhYzQw
-    YjJjMzAzZmFmYWU5NDk2ZmU3ODQ1YzU2ZDc2ZjViMjdjMjY0ZWI2OWIzODNk
-    NGE1ZTFmNTRmYWQyOWQ5YWRiZjNmY2IyODQ1NjIyYmM5M2M1ODI=
+  metadata.gz: c9b311d3790c86e79cab9d454dbef60c67ffbf3c9731772bdb076da5325f9615838f001bbe056268e8dd23d023f1364ab1c2918b8cce8d52c709d4c6fbe8b668
+  data.tar.gz: 06a57c4494ff2d21610ded78dbe7ae679ca903846cb860b636f6b5f0397a3367688c59754577c32334749e4517dc6e970f2818cf9bb52106b64d8b912e358bc1

data/.rspec

@@ -1 +1 @@
---color
+--color

data/Gemfile

@@ -18,6 +18,7 @@ group :development do
 end
 
 group :development, :test do
+  gem 'pry-remote'
   gem 'pry'
 end
 

data/Guardfile

@@ -6,4 +6,3 @@ guard :rspec, cli: '--color --format nested' do
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
-

data/LICENSE.txt

@@ -15,4 +15,4 @@ 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.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -39,9 +39,10 @@ There are several components that make up the full request/response circle with
 A request criteria in this context is a ruby object which contains the criteria that is to be
 passed to the driver.
 
-| Name           | Required? | Description 
-| -------------- |:---------:| ----------- 
+| Name           | Required? | Description
+| -------------- |:---------:| -----------
 | query          |     No    | Search term
+| channel        |     No    | Id for channel (currently only supported by the youtube driver)
 | page           |     No    | Page of results. Defaults to 0
 | per_page       |     No    | Items to return per page. Defaults to 25
 | content_filter |     No    | Filter flag. Can either be `none` or `strict`. Defaults to `none`
@@ -173,8 +174,8 @@ embed the video (iframe) or link to the video (url).
 * **driver**    - name of driver used (e.g. vimeo, youtube, quizlet, etc.)
 * **remote_id** - id of media provided by the driver
 * **url**       - The url. Likely used as the 'href' attribute of the inserted link
-* **text**      - this is the suggested text for the inserted link. If the user has already selected 
-                  some content before opening this dialog, the link will wrap that content and this 
+* **text**      - this is the suggested text for the inserted link. If the user has already selected
+                  some content before opening this dialog, the link will wrap that content and this
                   value may be ignored
 * **title**     - this is used as the 'title' attribute of the inserted link
 * **target**    - this is used as the 'target' attribute of the inserted link
@@ -186,12 +187,12 @@ A driver in this context is a ruby class which performs requests and returns a r
 ### Vimeo
 
 To use the Vimeo API, you must have credentials already. This requires a Vimeo app to
-be registered. You can do it at [https://developer.vimeo.com/apps](https://developer.vimeo.com/apps). 
-There are 4 params which are necessary to perform the requests: 
+be registered. You can do it at [https://developer.vimeo.com/apps](https://developer.vimeo.com/apps).
+There are 4 params which are necessary to perform the requests:
 
-| Name                | Required? | Description 
-| ------------------- |:---------:| ------------- 
-| consumer_key        |    Yes    | Vimeo API Client ID 
+| Name                | Required? | Description
+| ------------------- |:---------:| -------------
+| consumer_key        |    Yes    | Vimeo API Client ID
 | consumer_secret     |    Yes    | Vimeo API Client Secret
 | access_token        |    Yes    | Vimeo API OAuth Access Token
 | access_token_secret |    Yes    | Vimeo API OAuth Access Token Secret
@@ -277,8 +278,8 @@ more_results = schooltube.perform_request( results.next_criteria )
 Quizlet requires and Client ID to perform API requests. You can get this by visiting
 [https://quizlet.com/api-dashboard](https://quizlet.com/api-dashboard).
 
-| Name      | Required? | Description 
-| --------- |:---------:| ------------- 
+| Name      | Required? | Description
+| --------- |:---------:| -------------
 | client_id |    Yes    | Quizlet Client ID (used for public and user access)
 
 #### Return Types

data/Rakefile

@@ -4,4 +4,4 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new('spec')
 
 task :default => :spec
-task :test => :spec
+task :test => :spec

data/active_public_resources_config.yml.example

@@ -7,4 +7,4 @@ youtube:
 schooltube:
 khan_academy:
 quizlet:
-  client_id: QUIZLET_CLIENT_ID
+  client_id: QUIZLET_CLIENT_ID

data/lib/active_public_resources/base_response_type.rb

@@ -2,7 +2,7 @@ module ActivePublicResources
   module ResponseTypes
     class BaseResponseType
       include ::ActiveModel::Serialization
-      
+
       attr_accessor :id, :title, :description, :return_types, :kind
 
       def initialize

data/lib/active_public_resources/base_return_type.rb

@@ -2,7 +2,7 @@ module ActivePublicResources
   module ReturnTypes
     class BaseReturnType
       include ::ActiveModel::Serialization
-      
+
       attr_accessor :url, :return_type, :driver, :remote_id
 
       def initialize(args)

data/lib/active_public_resources/driver.rb

@@ -1,7 +1,7 @@
 module ActivePublicResources
   module Drivers
     class Driver
-      
+
       def perform_request(*args)
         raise NotImplementedError.new("You must implement perform_request.")
       end
@@ -15,7 +15,7 @@ module ActivePublicResources
           end
         end
       end
-      
+
     end
   end
 end

data/lib/active_public_resources/driver_response.rb

@@ -2,7 +2,7 @@ module ActivePublicResources
   module Drivers
     class DriverResponse
       include ::ActiveModel::Serializers::JSON
-      
+
       attr_accessor :items, :criteria, :next_criteria, :total_items
 
       def initialize(args)

data/lib/active_public_resources/drivers/khan_academy.rb

@@ -45,7 +45,7 @@ module ActivePublicResources
 
       def parse_results(request_criteria, results, videos=[], exercises=[])
         parent_id = parse_parent_id(results['slug'], results['extended_slug'])
-        
+
         driver_response = DriverResponse.new(
           :criteria      => request_criteria,
           :next_criteria => nil,

data/lib/active_public_resources/drivers/vimeo.rb

@@ -21,9 +21,9 @@ module ActivePublicResources
       # @option config_options [String] :access_token        Vimeo access token (required)
       # @option config_options [String] :access_token_secret Vimeo access token secret (required)
       def initialize(config_options={})
-        validate_options(config_options, 
+        validate_options(config_options,
           [:consumer_key, :consumer_secret, :access_token, :access_token_secret])
-        
+
         @client = ::Vimeo::Advanced::Video.new(
           config_options[:consumer_key],
           config_options[:consumer_secret],
@@ -45,7 +45,7 @@ module ActivePublicResources
       # @example Request
       #   driver = ActivePublicResources::Drivers::Vimeo.new({ .. config options .. })
       #   results = driver.perform_request({ query: 'education' })
-      #     
+      #
       # @example Returns
       #   {
       #     'items': [
@@ -83,7 +83,7 @@ module ActivePublicResources
       def perform_request(request_criteria)
         request_criteria.validate_presence!([:query])
         raise StandardError.new("driver has not been initialized properly") unless @client
-        
+
         results = @client.search(request_criteria.query, {
           :page           => request_criteria.page || 1,
           :per_page       => request_criteria.per_page || 25,

data/lib/active_public_resources/drivers/youtube.rb

@@ -8,23 +8,35 @@ module ActivePublicResources
       DRIVER_NAME = "youtube"
       API_KEY = ENV['YOUTUBE_API_KEY']
 
+      def initialize(config_options={})
+        @default_request_criteria = {}
+        if config_options[:default_request_criteria]
+          @default_request_criteria = config_options[:default_request_criteria]
+        end
+      end
+
       def perform_request(request_criteria)
-        request_criteria.validate_presence!([:query])
+        request_criteria.set_default_criteria!(@default_request_criteria)
+        unless request_criteria.validate_presence(:query) || request_criteria.validate_presence(:channel)
+          raise ArgumentError "you must specify at least a query or a channel"
+        end
+
         uri = URI('https://www.googleapis.com/youtube/v3/search')
         params = {
-          'q'           => request_criteria.query,
+          'q' => request_criteria.query,
           'part' => 'snippet',
           'type' => 'video',
-          'order'     => sort(request_criteria.sort),
-          'safeSearch'  => content_filter(request_criteria.content_filter),
+          'order' => sort(request_criteria.sort),
+          'safeSearch' => content_filter(request_criteria.content_filter),
           'maxResults' => request_criteria.per_page || 25,
           'key' => API_KEY
         }
+
         params['pageToken'] = request_criteria.page if request_criteria.is_a? String
         params['userIp'] = request_criteria.remote_ip if request_criteria.remote_ip
+        params['channelId'] = channel_id(request_criteria.channel_name) if channel_id(request_criteria.channel_name)
 
         uri.query = URI.encode_www_form(params)
-
         res = Net::HTTP.get_response(uri)
         results = JSON.parse(res.body)
         return video_details(request_criteria, results)
@@ -32,6 +44,27 @@ module ActivePublicResources
 
     private
 
+      def channel_id(channel_name)
+        # we are getting the name of the channel.
+        # we need to figure out its ID
+        if channel_name
+          uri = URI('https://www.googleapis.com/youtube/v3/search')
+          params = {
+            'q' => channel_name,
+            'part' => 'id',
+            'type' => 'channel',
+            'key' => API_KEY
+          }
+          uri.query = URI.encode_www_form(params)
+          res = Net::HTTP.get_response(uri)
+          results = JSON.parse(res.body)
+          return results['items'].first['id']['channelId'] unless results['items'].empty?
+        end
+
+        return false
+      end
+
+
       def video_details(request_criteria, results)
         video_ids = results['items'].map { |item| item['id']['videoId']}
         uri = URI('https://www.googleapis.com/youtube/v3/videos')

data/lib/active_public_resources/request_criteria.rb

@@ -1,7 +1,7 @@
 module ActivePublicResources
   class RequestCriteria
     include ::ActiveModel::Serialization
-      
+
     SORTS = [
       SORT_RELEVANCE = 'relevance',
       SORT_RECENT    = 'recent',
@@ -13,7 +13,7 @@ module ActivePublicResources
       CONTENT_FILTER_STRICT = 'strict'
     ]
 
-    attr_accessor :query, :page, :per_page, :content_filter, :sort, :folder, :remote_ip
+    attr_accessor :query, :page, :per_page, :content_filter, :sort, :folder, :remote_ip, :channel_name
 
     def initialize(args={})
       args.each do |k,v|
@@ -41,6 +41,16 @@ module ActivePublicResources
       @content_filter = val
     end
 
+    def validate_presence(attr_name, *attr_names)
+      attr_names.unshift(attr_name)
+      attr_names.each do |k|
+        if instance_variable_get("@#{k}").blank?
+          return false
+        end
+      end
+      true
+    end
+
     def validate_presence!(attr_names)
       attr_names.each do |k|
         if instance_variable_get("@#{k}").blank?
@@ -49,8 +59,14 @@ module ActivePublicResources
       end
     end
 
+    def set_default_criteria!(default_criteria)
+      default_criteria.map do |k, v|
+        instance_variable_set("@#{k}", v) unless validate_presence(k)
+      end
+    end
+
     def attributes
       instance_values
     end
   end
-end
+end

data/lib/active_public_resources/return_types/file.rb

@@ -2,7 +2,7 @@ module ActivePublicResources
   module ReturnTypes
     class File < BaseReturnType
       attr_accessor :text, :content_type
-      
+
       def initialize(args)
         super(args.merge(:return_type => 'file'))
       end

data/lib/active_public_resources/return_types/iframe.rb

@@ -2,7 +2,7 @@ module ActivePublicResources
   module ReturnTypes
     class Iframe < BaseReturnType
       attr_accessor :title, :width, :height
-      
+
       def initialize(args)
         super(args.merge(:return_type => 'iframe'))
       end

data/lib/active_public_resources/return_types/image_url.rb

@@ -2,7 +2,7 @@ module ActivePublicResources
   module ReturnTypes
     class ImageUrl < BaseReturnType
       attr_accessor :text, :width, :height
-      
+
       def initialize(args)
         super(args.merge(:return_type => 'image_url'))
       end

data/lib/active_public_resources/version.rb

@@ -1,3 +1,3 @@
 module ActivePublicResources
-  VERSION = "0.1.4"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,95 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: active_public_resources
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.2
 platform: ruby
 authors:
 - Eric Berry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: iso8601
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.6
 - !ruby/object:Gem::Dependency
   name: vimeo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.3
 - !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'
-description: ! ' Normalized searching and browsing of public resources '
+description: " Normalized searching and browsing of public resources "
 email:
 - cavneb@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -162,17 +162,17 @@ 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.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Normalized searching and browsing of public resources