active_public_resources 0.0.2

data/lib/active_public_resources/response_types/folder.rb

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

data/lib/active_public_resources/response_types/image.rb

@@ -0,0 +1,11 @@
+module ActivePublicResources
+  module ResponseTypes
+    class Image < BaseResponseType
+      attr_accessor :url, :width, :height
+
+      def kind
+        'image'
+      end
+    end
+  end
+end

data/lib/active_public_resources/response_types/quiz.rb

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

data/lib/active_public_resources/response_types/video.rb

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

data/lib/active_public_resources/return_types/file.rb

@@ -0,0 +1,11 @@
+module ActivePublicResources
+  module ReturnTypes
+    class File < BaseReturnType
+      attr_accessor :text, :content_type
+
+      def return_type
+        'file'
+      end
+    end
+  end
+end

data/lib/active_public_resources/return_types/iframe.rb

@@ -0,0 +1,11 @@
+module ActivePublicResources
+  module ReturnTypes
+    class Iframe < BaseReturnType
+      attr_accessor :title, :width, :height
+
+      def return_type
+        'iframe'
+      end
+    end
+  end
+end

data/lib/active_public_resources/return_types/image_url.rb

@@ -0,0 +1,11 @@
+module ActivePublicResources
+  module ReturnTypes
+    class ImageUrl < BaseReturnType
+      attr_accessor :text, :width, :height
+
+      def return_type
+        'image_url'
+      end
+    end
+  end
+end

data/lib/active_public_resources/return_types/oembed.rb

@@ -0,0 +1,11 @@
+module ActivePublicResources
+  module ReturnTypes
+    class Oembed < BaseReturnType
+      attr_accessor :endpoint
+
+      def return_type
+        'oembed'
+      end
+    end
+  end
+end

data/lib/active_public_resources/return_types/url.rb

@@ -0,0 +1,11 @@
+module ActivePublicResources
+  module ReturnTypes
+    class Url < BaseReturnType
+      attr_accessor :text, :title, :target
+
+      def return_type
+        'url'
+      end
+    end
+  end
+end

data/lib/active_public_resources/version.rb

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

data/lib/active_public_resources.rb

@@ -0,0 +1,55 @@
+require "active_support"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/inflections"
+require "active_public_resources/version"
+require "active_public_resources/client"
+require "active_public_resources/request_criteria"
+
+# Drivers
+require "active_public_resources/driver"
+require "active_public_resources/driver_response"
+require "active_public_resources/drivers/vimeo"
+require "active_public_resources/drivers/youtube"
+require "active_public_resources/drivers/schooltube"
+require "active_public_resources/drivers/khan_academy"
+require "active_public_resources/drivers/quizlet"
+
+# Return Types
+require "active_public_resources/base_return_type"
+require "active_public_resources/return_types/file"
+require "active_public_resources/return_types/iframe"
+require "active_public_resources/return_types/image_url"
+require "active_public_resources/return_types/oembed"
+require "active_public_resources/return_types/url"
+
+# Response Types
+require "active_public_resources/base_response_type"
+require "active_public_resources/response_types/video"
+require "active_public_resources/response_types/image"
+require "active_public_resources/response_types/exercise"
+require "active_public_resources/response_types/folder"
+require "active_public_resources/response_types/quiz"
+
+module ActivePublicResources
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+
+  def self.symbolize_keys(hash)
+    hash.inject({}){|result, (key, value)|
+      new_key = case key
+                when String then key.to_sym
+                else key
+                end
+      new_value = case value
+                  when Hash then symbolize_keys(value)
+                  when Array then value.map{ |v| v.is_a?(Hash) ? symbolize_keys(v) : v }
+                  else value
+                  end
+      result[new_key] = new_value
+      result
+    }
+  end
+end
+
+APR = ActivePublicResources

data/spec/lib/active_public_resources/client_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe APR::Client do
+
+  let(:client)   { APR::Client.new(config_data) }
+  let(:criteria) { APR::RequestCriteria.new({ :query => "education" }) }
+
+  describe ".initialize" do
+    it "requires valid config as initialize params" do
+      expect {
+        APR::Client.new
+      }.to raise_error(ArgumentError, "key/value pair must be provided")
+    end
+
+    it "with valid config" do
+      client.initialized_drivers.should include :vimeo
+    end
+  end
+
+  describe "vimeo" do
+    it "should perform request", :vcr, :record => :none do
+      results = client.perform_request(:vimeo, criteria)
+      next_criteria = results.next_criteria
+      next_criteria.page.should eq(2)
+      next_criteria.per_page.should eq(25)
+      results.total_items.should eq(141538)
+      results.items.length.should eq(25)
+    end
+  end
+
+  describe "youtube" 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.per_page.should eq(25)
+      results.total_items.should eq(1000000)
+      results.items.length.should eq(25)
+    end
+  end
+
+  describe "shooltube" do
+    it "should perform request", :vcr, :record => :none do
+      results = client.perform_request(:schooltube, criteria)
+      next_criteria = results.next_criteria
+      next_criteria.page.should eq(2)
+      next_criteria.per_page.should eq(25)
+      results.items.length.should eq(25)
+    end
+  end
+
+  describe "khan_academy" do
+    it "should traverse folders", :vcr, :record => :none do
+      results = client.perform_request(:khan_academy, criteria)
+      results.items.length.should eq(14)
+
+      folder = results.items.first
+      rc_2 = APR::RequestCriteria.new({ folder: folder.id });
+      results_2 = client.perform_request(:khan_academy, rc_2)
+      results_2.items.length.should eq(30)
+      results_2.items.map(&:kind).uniq.should eq(['video'])
+    end
+  end
+
+  describe "quizlet" do
+    it "should perform request", :vcr, :record => :none do
+      results = client.perform_request(:quizlet, criteria)
+      next_criteria = results.next_criteria
+      next_criteria.page.should eq(2)
+      next_criteria.per_page.should eq(25)
+      results.items.length.should eq(25)
+    end
+  end
+
+end

data/spec/lib/active_public_resources/driver_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe APR::Drivers::Driver do
+
+  it "should raises NotImplementedError" do
+    class APR::Drivers::Foo < APR::Drivers::Driver
+    end
+    [:perform_request].each do |mthd|
+      expect {
+        APR::Drivers::Foo.new.send(mthd)
+      }.to raise_error(NotImplementedError)
+    end
+  end
+
+  it "should not raise error when methods are overridden" do
+    class APR::Drivers::Foo < APR::Drivers::Driver
+      def perform_request(*args); end
+    end
+    [:perform_request].each do |mthd|
+      expect {
+        APR::Drivers::Foo.new.send(mthd)
+      }.not_to raise_error
+    end
+  end
+
+  describe "#validate_options" do
+    before :each do
+      class APR::Drivers::Foo < APR::Drivers::Driver
+        def initialize(opts={})
+          validate_options(opts, [:a, :b, :c])
+        end
+      end
+    end
+
+    it "should raise error when options are not valid" do
+      expect {
+        APR::Drivers::Foo.new
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should not raise error when options are valid" do
+      expect {
+        APR::Drivers::Foo.new({ a: 'x', b: 'y', c: 'z' })
+      }.not_to raise_error
+    end
+  end
+
+end

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

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe APR::Drivers::KhanAcademy do
+
+  let(:driver) { APR::Drivers::KhanAcademy.new }
+
+  describe "#perform_request" do
+    it "should get root folders", :vcr, :record => :none do
+      search_criteria = APR::RequestCriteria.new
+      results = driver.perform_request(search_criteria)
+      results.total_items.should eq(14)
+      results.items.length.should eq(14)
+      results.next_criteria.should be_nil
+
+      folder = results.items.first
+      folder.id.should eq("new-and-noteworthy")
+      folder.title.should eq("New and noteworthy")
+      folder.parent_id.should be_nil
+    end
+
+    it "should get folder: cs", :vcr, :record => :none do
+      search_criteria = APR::RequestCriteria.new(
+        { folder: "cs" }
+      )
+      results = driver.perform_request(search_criteria)
+      results.total_items.should eq(1)
+      results.items.length.should eq(1)
+      results.next_criteria.should be_nil
+
+      folder = results.items.first
+      folder.id.should eq("programming")
+      folder.title.should eq("Drawing and animation")
+      folder.parent_id.should eq("root")
+    end
+
+    it "should get folder: cs/programming", :vcr, :record => :none do
+      search_criteria = APR::RequestCriteria.new(
+        { folder: "programming" }
+      )
+      results = driver.perform_request(search_criteria)
+      results.total_items.should eq(12)
+      results.items.length.should eq(12)
+      results.next_criteria.should be_nil
+
+      folder = results.items.first
+      folder.id.should eq("intro-to-programming")
+      folder.title.should eq("Intro to programming")
+      folder.parent_id.should eq("cs")
+    end
+
+    it "should get folder: science/mcat/society-and-culture/social-structures", :vcr, :record => :none do
+      search_criteria = APR::RequestCriteria.new(
+        { folder: "social-structures" }
+      )
+      results = driver.perform_request(search_criteria)
+      results.total_items.should eq(8)
+      results.items.length.should eq(8)
+      results.next_criteria.should be_nil
+
+      videos = results.items.find_all { |item| item.kind == "video" }
+      videos.length.should be(6)
+      video = videos.first
+      video.kind.should eq("video")
+      video.title.should eq("Institutions")
+      video.description.should match /Institutions are structures of society/
+      video.thumbnail_url.should eq("https://img.youtube.com/vi/9KR1bad76qg/hqdefault.jpg")
+      video.url.should eq("http://www.youtube.com/watch?v=9KR1bad76qg&feature=youtube_gdata_player")
+      video.duration.should eq(207)
+      video.num_views.should eq(0)
+      video.num_likes.should eq(0)
+      video.num_comments.should eq(0)
+      video.created_date.strftime("%Y-%m-%d").should eq("2013-10-10")
+      video.username.should eq("Sydney Brown")
+
+      rt_url = video.return_types[0]
+      rt_url.return_type.should eq('url')
+      rt_url.url.should eq("http://www.youtube.com/watch?v=9KR1bad76qg&feature=youtube_gdata_player")
+      rt_url.title.should eq("Institutions")
+
+      rt_iframe = video.return_types[1]
+      rt_iframe.return_type.should eq('iframe')
+      rt_iframe.url.should eq("//www.youtube.com/embed/9KR1bad76qg?feature=oembed")
+      rt_url.title.should eq("Institutions")
+
+      video.width.should eq(640)
+      video.height.should eq(360)
+
+      exercises = results.items.find_all { |item| item.kind == "exercise" }
+      exercises.length.should be(2)
+      exercise = exercises.first
+      exercise.kind.should eq("exercise")
+      exercise.id.should eq("exd53ad0de")
+      exercise.title.should eq("Social structures - Passage 1")
+      exercise.thumbnail_url.should eq("https://ka-exercise-screenshots.s3.amazonaws.com/social-structures---passage-1_256.png")
+      exercise.url.should eq("http://www.khanacademy.org/exercise/social-structures---passage-1")
+
+      ex_rt_url = exercise.return_types[0]
+      ex_rt_url.return_type.should eq('url')
+      ex_rt_url.url.should eq("http://www.khanacademy.org/exercise/social-structures---passage-1")
+      ex_rt_url.title.should eq("Social structures - Passage 1")
+
+      exercise.return_types
+    end
+  end
+  
+end

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

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe APR::Drivers::Quizlet do
+
+  let(:driver) { APR::Drivers::Quizlet.new(config_data[:quizlet]) }
+
+  describe ".initialize" do
+    it "should throw error when intializing without proper config options" do
+      expect {
+        APR::Drivers::Quizlet.new
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#perform_request" do
+    it "should raise error when perform_request method is called without a query" do
+      expect {
+        driver.perform_request(APR::RequestCriteria.new)
+      }.to raise_error(StandardError, "must include query")
+    end
+
+    it "should perform request", :vcr, :record => :none do
+      search_criteria = APR::RequestCriteria.new({:query => "dogs"})
+      results = driver.perform_request(search_criteria)
+
+      next_criteria = results.next_criteria
+      next_criteria.page.should eq(2)
+      next_criteria.per_page.should eq(25)
+      results.items.length.should eq(25)
+
+      quiz = results.items.first
+      quiz.kind.should eq("quiz")
+      quiz.title.should eq("Dogs")
+      quiz.description.should eq("DOGS, DOGS, DOGS!!!!!!!!")
+      quiz.url.should eq("http://quizlet.com/23752218/dogs-flash-cards/")
+      quiz.created_date.strftime("%Y-%m-%d").should eq("2013-05-25")
+
+      quiz.return_types.map(&:url).should eq([
+        "http://quizlet.com/23752218/dogs-flash-cards/",
+        "https://quizlet.com/23752218/flashcards/embedv2",
+        "https://quizlet.com/23752218/learn/embedv2",
+        "https://quizlet.com/23752218/scatter/embedv2",
+        "https://quizlet.com/23752218/speller/embedv2",
+        "https://quizlet.com/23752218/test/embedv2",
+        "https://quizlet.com/23752218/spacerace/embedv2"
+      ])
+    end
+  end
+  
+end

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

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe APR::Drivers::Schooltube do
+
+  let(:driver) { APR::Drivers::Schooltube.new }
+
+  describe "#perform_request" do
+    it "should raise error when perform_request method is called without a query" do
+      expect {
+        driver.perform_request(APR::RequestCriteria.new)
+      }.to raise_error(StandardError, "must include query")
+    end
+
+    it "should perform request", :vcr, :record => :none 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.per_page.should eq(25)
+      results.items.length.should eq(25)
+
+      item = results.items.first
+      item.kind.should eq("video")
+      item.title.should eq("Fun - Educational School Trips - Call American Tours & Travel")
+      item.description.should match /customizing your next student/
+      item.thumbnail_url.should eq("http://schooltube-thumbnails.s3.amazonaws.com/c5/c3/dd/df/9c/f6/c5c3dddf-9cf6-c0e5-db1f-898f89c301e2.jpg")
+      item.url.should eq("http://bit.ly/pk3Sxs")
+      item.duration.should eq(102)
+      item.num_views.should eq(3513)
+      item.num_likes.should eq(0)
+      item.num_comments.should eq(0)
+      item.created_date.strftime("%Y-%m-%d").should eq("2009-11-12")
+      item.username.should eq("StudentGroupTravel")
+
+      rt_url = item.return_types[0]
+      rt_url.return_type.should eq('url')
+      rt_url.url.should eq("http://bit.ly/pk3Sxs")
+      rt_url.title.should eq("Fun - Educational School Trips - Call American Tours & Travel")
+
+      rt_iframe = item.return_types[1]
+      rt_iframe.return_type.should eq('iframe')
+      rt_iframe.url.should eq("//www.schooltube.com/embed/60f374fdba394a70b4ad")
+      rt_url.title.should eq("Fun - Educational School Trips - Call American Tours & Travel")
+
+      item.width.should eq(640)
+      item.height.should eq(360)
+    end
+  end
+  
+end

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

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe APR::Drivers::Vimeo do
+
+  let(:driver) { APR::Drivers::Vimeo.new(config_data[:vimeo]) }
+  
+  describe ".initialize" do
+    it "should throw error when intializing without proper config options" do
+      expect {
+        APR::Drivers::Vimeo.new
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should build a vimeo client on initialize" do
+      driver.client.should be_an_instance_of(::Vimeo::Advanced::Video)
+    end
+  end
+
+  describe "#perform_request" do
+    it "should raise error when perform_request method is called without a query" do
+      expect {
+        driver.perform_request(APR::RequestCriteria.new)
+      }.to raise_error(StandardError, "must include query")
+    end
+
+    it "should raise error when client has not been set" do
+      driver.instance_variable_set("@client", nil)
+      search_criteria = APR::RequestCriteria.new({:query => "education"})
+      expect {
+        driver.perform_request(search_criteria)
+      }.to raise_error(StandardError, "driver has not been initialized properly")
+    end
+
+    it "should perform request", :vcr, :record => :none 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.per_page.should eq(25)
+      results.total_items.should eq(145819)
+      results.items.length.should eq(25)
+
+      item = results.items.first
+      item.kind.should eq("video")
+      item.title.should eq("Kynect 'education'")
+      item.description.should match /Character Design/
+      item.thumbnail_url.should eq("http://b.vimeocdn.com/ts/440/661/440661028_100.jpg")
+      item.url.should eq("http://vimeo.com/67741947")
+      item.duration.should eq(30)
+      item.num_views.should eq(16593)
+      item.num_likes.should eq(911)
+      item.num_comments.should eq(39)
+      item.created_date.strftime("%Y-%m-%d").should eq("2013-06-05")
+      item.username.should eq("Jens & Anna")
+
+      rt_url = item.return_types[0]
+      rt_url.return_type.should eq('url')
+      rt_url.url.should eq("http://vimeo.com/67741947")
+      rt_url.title.should eq("Kynect 'education'")
+
+      rt_iframe = item.return_types[1]
+      rt_iframe.return_type.should eq('iframe')
+      rt_iframe.url.should eq("//player.vimeo.com/video/67741947")
+      rt_url.title.should eq("Kynect 'education'")
+
+      item.width.should eq(640)
+      item.height.should eq(360)
+    end
+  end
+  
+end

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

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe APR::Drivers::Youtube do
+
+  let(:driver) { APR::Drivers::Youtube.new }
+
+  describe "#perform_request" do
+    it "should raise error when perform_request method is called without a query" do
+      expect {
+        driver.perform_request(APR::RequestCriteria.new)
+      }.to raise_error(StandardError, "must include query")
+    end
+
+    it "should perform request", :vcr, :record => :none 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.per_page.should eq(25)
+      results.total_items.should eq(1000000)
+      results.items.length.should eq(25)
+
+      item = results.items.first
+      item.kind.should eq("video")
+      item.title.should eq("Why I Hate School But Love Education||Spoken Word")
+      item.description.should match /The Latest Spoken Word/
+      item.thumbnail_url.should eq("https://i.ytimg.com/vi/y_ZmM7zPLyI/default.jpg")
+      item.url.should eq("https://www.youtube.com/watch?v=y_ZmM7zPLyI&feature=youtube_gdata_player")
+      item.duration.should eq(368)
+      item.num_views.should eq(4228173)
+      item.num_likes.should eq(101737)
+      item.num_comments.should eq(17837)
+      item.created_date.strftime("%Y-%m-%d").should eq("2012-12-02")
+      item.username.should eq("sulibreezy")
+      item.return_types.count.should eq(2)
+
+      rt_url = item.return_types[0]
+      rt_url.return_type.should eq('url')
+      rt_url.url.should eq("https://www.youtube.com/watch?v=y_ZmM7zPLyI&feature=youtube_gdata_player")
+      rt_url.title.should eq("Why I Hate School But Love Education||Spoken Word")
+
+      rt_iframe = item.return_types[1]
+      rt_iframe.return_type.should eq('iframe')
+      rt_iframe.url.should eq("//www.youtube.com/embed/y_ZmM7zPLyI?feature=oembed")
+      rt_url.title.should eq("Why I Hate School But Love Education||Spoken Word")
+
+      item.width.should eq(640)
+      item.height.should eq(360)
+    end
+  end
+  
+end