active_public_resources 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f82492f1e5cfc67fee25365b48d83ce58efa170
-  data.tar.gz: f45c20c7330389c2f59b8f3aad0e03b558780a7a
+  metadata.gz: a324e715f7ee235b96e91cf77d6b58154507ecd2
+  data.tar.gz: 93c73395724d5ae8d64be0e9cc2a6b649d6d3a2e
 SHA512:
-  metadata.gz: 06100044d338f7837c23684f3ea49f7803242300a08497f90e45bceb1ed00826090dbc8e122d5ef2eeced25eb95019a2959473eccdc2c6baa63edd618d092e15
-  data.tar.gz: bbbbe5c9448f2b80ffcd3c2f51f8a72a5f258b8437a4fd91d066ae78220bc15130c9cc4af4a12a17e64f390076f42d6e9b2701d30cd420a2b99e16605497df59
+  metadata.gz: eb36f13ff2951a32db75ac28ffa75e47a7f2ba11517488d64d764d379592c3a8b5bfad158ad235373b3169a32dc3599687dc7ed74e338b51977828a3db1efe4b
+  data.tar.gz: fd7a53620ad17cde8d643280bad3fcf706873f9e32b2064736906605db41040fe64d5dbde9acdfe1cddfd5113c87e7370c565636a49282177c00041386675a5c

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.org/instructure/active_public_resources.png)](https://travis-ci.org/instructure/active_public_resources)
 [![Code Climate](https://codeclimate.com/github/instructure/active_public_resources.png)](https://codeclimate.com/github/instructure/active_public_resources)
+[![Gemnasium](https://gemnasium.com/instructure/active_public_resources.png)](https://gemnasium.com/instructure/active_public_resources)
+[![Gem Version](https://badge.fury.io/rb/active_public_resources.png)](http://badge.fury.io/rb/active_public_resources)
 
 Active Public Resources is a collection of resources online which return embeddable or linkable
 resources. This gem normalizes the requests and responses into response type objects.

data/active_public_resources.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "active_support", ">= 3.0.0"
+  spec.add_dependency "activemodel", ">= 3.0.0"
 
   # Drivers
   spec.add_dependency "vimeo", "~> 1.5.3"

data/lib/active_public_resources/base_response_type.rb

@@ -1,11 +1,17 @@
 module ActivePublicResources
   module ResponseTypes
     class BaseResponseType
-      attr_accessor :id, :title, :description, :return_types
+      include ::ActiveModel::Serialization
+      
+      attr_accessor :id, :title, :description, :return_types, :kind
 
       def initialize
         @return_types = []
       end
+
+      def attributes
+        instance_values
+      end
     end
   end
 end

data/lib/active_public_resources/base_return_type.rb

@@ -1,7 +1,9 @@
 module ActivePublicResources
   module ReturnTypes
     class BaseReturnType
-      attr_accessor :url
+      include ::ActiveModel::Serialization
+      
+      attr_accessor :url, :return_type
 
       def initialize(args)
         args.each do |k,v|
@@ -9,8 +11,8 @@ module ActivePublicResources
         end
       end
 
-      def return_type
-        raise NotImplementedError.new("You must implement return_type.")
+      def attributes
+        instance_values
       end
     end
   end

data/lib/active_public_resources/driver_response.rb

@@ -1,6 +1,8 @@
 module ActivePublicResources
   module Drivers
     class DriverResponse
+      include ::ActiveModel::Serializers::JSON
+      
       attr_accessor :items, :criteria, :next_criteria, :total_items
 
       def initialize(args)
@@ -10,6 +12,9 @@ module ActivePublicResources
         @items ||= []
       end
 
+      def attributes
+        instance_values
+      end
     end
   end
 end

data/lib/active_public_resources/drivers/khan_academy.rb

@@ -82,6 +82,7 @@ module ActivePublicResources
         video.description   = data['description']
         video.thumbnail_url = data['image_url']
         video.url           = data['url']
+        video.embed_url     = "//www.youtube.com/embed/#{data['youtube_id']}?feature=oembed"
         video.duration      = data['duration'] ? data['duration'].to_i : 0
         video.num_views     = 0
         video.num_likes     = 0

data/lib/active_public_resources/drivers/quizlet.rb

@@ -54,6 +54,7 @@ module ActivePublicResources
         quiz.title         = data['title']
         quiz.description   = data['description']
         quiz.url           = data['url']
+        quiz.username      = data['username']
         quiz.term_count    = data['term_count']
         quiz.created_date  = Time.at(data['created_date']).utc.to_date
         quiz.has_images    = data['has_images']

data/lib/active_public_resources/drivers/schooltube.rb

@@ -68,6 +68,7 @@ module ActivePublicResources
         video.description   = data['description']
         video.thumbnail_url = data['thumbnail_url']
         video.url           = data['short_url']
+        video.embed_url     = "//www.schooltube.com/embed/#{data['vkey']}"
         video.duration      = data['duration'] ? data['duration'].to_i : 0
         video.num_views     = data['view_count'] ? data['view_count'].to_i : 0
         video.num_likes     = data['thumbs_up'] ? data['thumbs_up'].to_i : 0

data/lib/active_public_resources/drivers/vimeo.rb

@@ -150,6 +150,7 @@ module ActivePublicResources
         video.description   = data['description']
         video.thumbnail_url = data['thumbnails']['thumbnail'][0]['_content']
         video.url           = data['urls']['url'][0]['_content']
+        video.embed_url     = "//player.vimeo.com/video/#{data['id']}"
         video.duration      = data['duration'].to_i
         video.num_views     = data['number_of_plays'].to_i
         video.num_likes     = data['number_of_likes'].to_i

data/lib/active_public_resources/drivers/youtube.rb

@@ -33,9 +33,9 @@ module ActivePublicResources
           when APR::RequestCriteria::SORT_RELEVANCE
             'relevance'
           when APR::RequestCriteria::SORT_RECENT
-            'relevance'
+            'published'
           when APR::RequestCriteria::SORT_POPULAR
-            'relevance'
+            'viewCount'
           else
             'relevance'
         end
@@ -62,13 +62,13 @@ module ActivePublicResources
       end
 
       def next_criteria(request_criteria, results)
-        page     = results['feed']['openSearch$startIndex']['$t'].to_i
-        per_page = results['feed']['openSearch$itemsPerPage']['$t'].to_i
-        total    = results['feed']['openSearch$totalResults']['$t'].to_i
-        if ((page * per_page) < total)
+        start_index = results['feed']['openSearch$startIndex']['$t'].to_i
+        per_page    = results['feed']['openSearch$itemsPerPage']['$t'].to_i
+        total       = results['feed']['openSearch$totalResults']['$t'].to_i
+        if (start_index + per_page) < total
           return RequestCriteria.new({
             :query    => request_criteria.query,
-            :page     => page + 1,
+            :page     => start_index + per_page,
             :per_page => per_page
           })
         end
@@ -82,6 +82,7 @@ module ActivePublicResources
         video.description   = data['media$group']['media$description']['$t']
         video.thumbnail_url = data['media$group']['media$thumbnail'][0]['url']
         video.url           = data['media$group']['media$player']['url']
+        video.embed_url     = "//www.youtube.com/embed/#{video_id}?feature=oembed"
         video.duration      = data['media$group']['yt$duration']['seconds'].to_i
         video.num_views     = data['yt$statistics'] ? data['yt$statistics']['viewCount'].to_i : 0
         video.num_likes     = data['yt$rating'] ? data['yt$rating']['numLikes'].to_i : 0

data/lib/active_public_resources/request_criteria.rb

@@ -1,6 +1,7 @@
 module ActivePublicResources
   class RequestCriteria
-
+    include ::ActiveModel::Serialization
+      
     SORTS = [
       SORT_RELEVANCE = 'relevance',
       SORT_RECENT    = 'recent',
@@ -47,5 +48,9 @@ module ActivePublicResources
         end
       end
     end
+
+    def attributes
+      instance_values
+    end
   end
 end

data/lib/active_public_resources/response_types/exercise.rb

@@ -3,8 +3,9 @@ module ActivePublicResources
     class Exercise < BaseResponseType
       attr_accessor :thumbnail_url, :url
 
-      def kind
-        'exercise'
+      def initialize
+        super
+        @kind = 'exercise'
       end
     end
   end

data/lib/active_public_resources/response_types/folder.rb

@@ -1,17 +1,11 @@
 module ActivePublicResources
   module ResponseTypes
     class Folder < BaseResponseType
-      attr_accessor :parent_id, :videos, :exercises, :images
+      attr_accessor :parent_id
 
       def initialize
         super
-        @videos    = []
-        @exercises = []
-        @images    = []
-      end
-
-      def kind
-        'folder'
+        @kind = 'folder'
       end
     end
   end

data/lib/active_public_resources/response_types/image.rb

@@ -3,8 +3,9 @@ module ActivePublicResources
     class Image < BaseResponseType
       attr_accessor :url, :width, :height
 
-      def kind
-        'image'
+      def initialize
+        super
+        @kind = 'image'
       end
     end
   end

data/lib/active_public_resources/response_types/quiz.rb

@@ -1,10 +1,11 @@
 module ActivePublicResources
   module ResponseTypes
     class Quiz < BaseResponseType
-      attr_accessor :url, :term_count, :created_date, :has_images, :subjects
+      attr_accessor :url, :term_count, :username, :created_date, :has_images, :subjects
 
-      def kind
-        'quiz'
+      def initialize
+        super
+        @kind = 'quiz'
       end
     end
   end

data/lib/active_public_resources/response_types/video.rb

@@ -1,11 +1,12 @@
 module ActivePublicResources
   module ResponseTypes
     class Video < BaseResponseType
-      attr_accessor :thumbnail_url, :url, :duration, :width, :height, :username,
+      attr_accessor :thumbnail_url, :url, :embed_url, :duration, :width, :height, :username,
                     :num_views, :num_likes, :num_comments, :created_date
 
-      def kind
-        'video'
+      def initialize
+        super
+        @kind = 'video'
       end
     end
   end

data/lib/active_public_resources/return_types/file.rb

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

data/lib/active_public_resources/return_types/iframe.rb

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

data/lib/active_public_resources/return_types/image_url.rb

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

data/lib/active_public_resources/return_types/oembed.rb

@@ -3,8 +3,8 @@ module ActivePublicResources
     class Oembed < BaseReturnType
       attr_accessor :endpoint
 
-      def return_type
-        'oembed'
+      def initialize(args)
+        super(args.merge(:return_type => 'oembed'))
       end
     end
   end

data/lib/active_public_resources/return_types/url.rb

@@ -3,8 +3,8 @@ module ActivePublicResources
     class Url < BaseReturnType
       attr_accessor :text, :title, :target
 
-      def return_type
-        'url'
+      def initialize(args)
+        super(args.merge(:return_type => 'url'))
       end
     end
   end

data/lib/active_public_resources/version.rb

@@ -1,3 +1,3 @@
 module ActivePublicResources
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/active_public_resources.rb

@@ -1,6 +1,8 @@
 require "active_support"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/string/inflections"
+require "active_model"
+
 require "active_public_resources/version"
 require "active_public_resources/client"
 require "active_public_resources/request_criteria"

data/spec/lib/active_public_resources/client_spec.rb

@@ -32,7 +32,7 @@ describe APR::Client do
     it "should perform request", :vcr, :record => :none do
       results = client.perform_request(:youtube, criteria)
       next_criteria = results.next_criteria
-      next_criteria.page.should eq(2)
+      next_criteria.page.should eq(26)
       next_criteria.per_page.should eq(25)
       results.total_items.should eq(1000000)
       results.items.length.should eq(25)

data/spec/lib/active_public_resources/driver_response_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe APR::Drivers::DriverResponse do
+
+  it "should render json" do
+    request_criteria = APR::RequestCriteria.new({
+      :query          => "education",
+      :page           => 1,
+      :per_page       => 25,
+      :sort           => APR::RequestCriteria::SORT_RELEVANCE,
+      :content_filter => APR::RequestCriteria::CONTENT_FILTER_NONE
+    })
+
+    next_criteria = APR::RequestCriteria.new({
+      :query          => "education",
+      :page           => 2,
+      :per_page       => 25,
+      :sort           => APR::RequestCriteria::SORT_RELEVANCE,
+      :content_filter => APR::RequestCriteria::CONTENT_FILTER_NONE
+    })
+
+    driver_response = APR::Drivers::DriverResponse.new(
+      :criteria      => request_criteria,
+      :next_criteria => next_criteria,
+      :total_items   => 5500,
+      :items         => [ exercise, folder, image, quiz, video ]
+    )
+
+    data = JSON.parse(driver_response.to_json)['driver_response']
+    data['criteria']['query'].should eq('education')
+    data['next_criteria']['page'].should eq(2)
+    data['total_items'].should eq(5500)
+    data['items'].length.should eq(5)
+    data['items'][0]['kind'].should eq('exercise')
+    data['items'][0]['title'].should eq(exercise.title)
+    data['items'][0]['return_types'][0]['text'].should eq(exercise.title)
+    data['items'][1]['kind'].should eq('folder')
+    data['items'][1]['title'].should eq(folder.title)
+    data['items'][2]['kind'].should eq('image')
+    data['items'][2]['title'].should eq(image.title)
+    data['items'][3]['kind'].should eq('quiz')
+    data['items'][3]['title'].should eq(quiz.title)
+    data['items'][3]['return_types'][0]['text'].should eq(quiz.title)
+    data['items'][4]['kind'].should eq('video')
+    data['items'][4]['title'].should eq(video.title)
+    data['items'][4]['return_types'][0]['text'].should eq(video.title)
+  end
+
+  private
+
+  def video
+    video = APR::ResponseTypes::Video.new
+    video.id            = 1
+    video.title         = 'Video Title'
+    video.description   = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit.'
+    video.thumbnail_url = 'http://placekitten.com/50/50.png'
+    video.url           = 'http://example.com/videos/1'
+    video.duration      = 150
+    video.num_views     = 1100
+    video.num_likes     = 600
+    video.num_comments  = 300
+    video.created_date  = Date.today
+    video.username      = 'joe'
+    video.width         = 640
+    video.height        = 360
+    video.return_types << APR::ReturnTypes::Url.new({
+      :url   => 'http://example.com/videos/1',
+      :text  => 'Video Title',
+      :title => 'Video Title'
+    })
+    video.return_types << APR::ReturnTypes::Url.new({
+      :url    => "//player.vimeo.com/video/1",
+      :text   => 'Video Title',
+      :title  => 'Video Title',
+      :width  => 640,
+      :height => 360
+    })
+    video
+  end
+
+  def folder
+    folder = APR::ResponseTypes::Folder.new
+    folder.id            = 1
+    folder.title         = 'Programming'
+    folder.description   = 'Programming videos'
+    folder.parent_id     = 'root'
+    folder
+  end
+
+  def exercise
+    exercise = APR::ResponseTypes::Exercise.new
+    exercise.id            = 1
+    exercise.title         = 'Exercise Title'
+    exercise.description   = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit.'
+    exercise.thumbnail_url = 'http://placekitten.com/50/50.png'
+    exercise.url           = 'http://example.com/exercise/1'
+    exercise.return_types << APR::ReturnTypes::Url.new({
+      :url => 'http://example.com/exercise/1',
+      :text => 'Exercise Title',
+      :title => 'Exercise Title'
+    })
+    exercise
+  end
+
+  def image
+    image = APR::ResponseTypes::Image.new
+    image.id          = 1
+    image.title       = 'Image Title'
+    image.description = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit.'
+    image.url         = 'http://placekitten.com/50/50.png'
+    image.width       = 50
+    image.height      = 50
+    image
+  end
+
+  def quiz
+    quiz = APR::ResponseTypes::Quiz.new
+    quiz.id          = 1
+    quiz.title       = 'Quiz Title'
+    quiz.description = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit.'
+    quiz.url         = 'http://placekitten.com/50/50.png'
+    quiz.return_types << APR::ReturnTypes::Url.new({
+      :url => 'http://placekitten.com/50/50.png',
+      :text => "Quiz Title",
+      :title => "Quiz Title"
+    })
+    quiz.return_types << APR::ReturnTypes::Url.new({
+      :url    => "https://quizlet.com/1/flashcards/embedv2",
+      :text   => "Flashcards",
+      :title  => "Quiz Title",
+      :width  => "100%",
+      :height => 410
+    })
+    quiz.return_types << APR::ReturnTypes::Url.new({
+      :url    => "https://quizlet.com/1/scatter/embedv2",
+      :text   => "Scatter",
+      :title  => "Quiz Title",
+      :width  => "100%",
+      :height => 410
+    })
+    quiz.return_types << APR::ReturnTypes::Url.new({
+      :url    => "https://quizlet.com/1/spacerace/embedv2",
+      :text   => "Space Race",
+      :title  => "Quiz Title",
+      :width  => "100%",
+      :height => 410
+    })
+    quiz
+  end
+
+end

data/spec/lib/active_public_resources/drivers/youtube_spec.rb

@@ -15,7 +15,7 @@ describe APR::Drivers::Youtube do
       search_criteria = APR::RequestCriteria.new({:query => "education"})
       results = driver.perform_request(search_criteria)
       next_criteria = results.next_criteria
-      next_criteria.page.should eq(2)
+      next_criteria.page.should eq(26)
       next_criteria.per_page.should eq(25)
       results.total_items.should eq(1000000)
       results.items.length.should eq(25)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_public_resources
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eric Berry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2013-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_support
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: vimeo
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +107,7 @@ files:
 - lib/active_public_resources/return_types/url.rb
 - lib/active_public_resources/version.rb
 - spec/lib/active_public_resources/client_spec.rb
+- spec/lib/active_public_resources/driver_response_spec.rb
 - spec/lib/active_public_resources/driver_spec.rb
 - spec/lib/active_public_resources/drivers/khan_academy_spec.rb
 - spec/lib/active_public_resources/drivers/quizlet_spec.rb
@@ -149,6 +164,7 @@ specification_version: 4
 summary: Normalized searching and browsing of public resources
 test_files:
 - spec/lib/active_public_resources/client_spec.rb
+- spec/lib/active_public_resources/driver_response_spec.rb
 - spec/lib/active_public_resources/driver_spec.rb
 - spec/lib/active_public_resources/drivers/khan_academy_spec.rb
 - spec/lib/active_public_resources/drivers/quizlet_spec.rb