active_public_resources 0.2.4 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 750a849ad37794a269bab5b663992a2ee9101a10
-  data.tar.gz: 17a0f5735242ebd52b93b020a3deb4a931ae3376
+SHA256:
+  metadata.gz: 4ebe0286bc9284b369d5695587db96781a0d1154dce4999e982582f8e256a0e5
+  data.tar.gz: 37f81f8de8e1536edcc2768de8a89527889c4460d254c3769fad2a6e2ffcbae6
 SHA512:
-  metadata.gz: d859e2ffb42e9b9dfa2b0e2bca4401de468d0e5aa34aeeb65e90b5a622436af796fadfe6014c1104b45fd12bdf10b77f10e032c8cd4c205f62aff20977b0e37d
-  data.tar.gz: 9953aebb19aa8ea776f35d8b98e74d4e90115781f0cb8f8e47390baa67965231be473f841b4047dde577fadb4d7fa495d99bb0259dd66838d4f16a37713f55c5
+  metadata.gz: f068b798cf7f861a201aea160f81a16e1c6ec77aa23bba5a35dce85ec9b037fe316d44a390e33379ad30d2dc93466d0322ed34df5e8b8a61bf29ae4694e6d209
+  data.tar.gz: 192cc69228d7b0b02a7cc65583ee19d612b65a8355e491e806febd86e57d5a2c87d5653c8902a32da3cb7135f4baa86da7c324b466424fc50888e03e265fbe7c

data/Gemfile

@@ -7,7 +7,7 @@ group :test do
   gem 'rspec',       '~> 2.14.1'
   # gem 'rspec-mocks', '~> 2.14.4'
   gem 'vcr'
-  gem 'webmock'
+  gem 'webmock', '~> 3.0.1'
   gem 'simplecov',   '~> 0.8.1', :require => false
   gem 'growl'
   gem 'growl-rspec'
@@ -19,7 +19,7 @@ end
 
 group :development, :test do
   gem 'pry-remote'
-  gem 'pry'
+  gem 'pry-byebug'
 end
 
 gemspec

data/README.md

@@ -188,14 +188,12 @@ A driver in this context is a ruby class which performs requests and returns a r
 
 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:
+There are two params which are necessary to perform the requests:
 
 | 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
 
 #### Return Types
 
@@ -204,22 +202,20 @@ Vimeo returns **Iframe** and **URL** return types.
 #### Example:
 
 ```ruby
-criteria = APR::RequestCriteria.new( query: "education" )
+criteria = APR::RequestCriteria.new(query: "education")
 
 vimeo = APR::Drivers::Vimeo.new(
   :consumer_key        => 'VIMEO_CONSUMER_KEY',
-  :consumer_secret     => 'VIMEO_CONSUMER_SECRET',
-  :access_token        => 'VIMEO_ACCESS_TOKEN',
-  :access_token_secret => 'VIMEO_ACCESS_TOKEN_SECRET'
+  :consumer_secret     => 'VIMEO_CONSUMER_SECRET'
 )
 
-results = vimeo.perform_request( criteria )
+results = vimeo.perform_request(criteria)
 results.items.length          # => 25
 results.total_items           # => 145063
 results.next_criteria         # => #<ActivePublicResources::RequestCriteria:0x007fa48392d388 @query="education", @page=2, @per_page=25>
 results.items.first.title     # => "Kynect 'education'"
 
-more_results = vimeo.perform_request( results.next_criteria )
+more_results = vimeo.perform_request(results.next_criteria)
 # ...
 ```
 

data/active_public_resources.gemspec

@@ -21,9 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", ">= 4.0.0"
   spec.add_dependency "activemodel", ">= 4.0.0"
   spec.add_dependency "iso8601", "~> 0.8.6"
-
-  # Drivers
-  spec.add_dependency "vimeo", "~> 1.5.3"
+  spec.add_dependency "httparty", "~> 0.15.6"
 
   spec.add_development_dependency "bundler", "~> 1.3"
 end

data/active_public_resources_config.yml.example

@@ -1,8 +1,6 @@
 vimeo:
   consumer_key: VIMEO_CONSUMER_KEY
   consumer_secret: VIMEO_CONSUMER_SECRET
-  access_token: VIMEO_ACCESS_TOKEN
-  access_token_secret: VIMEO_ACCESS_TOKEN_SECRET
 youtube:
 schooltube:
 khan_academy:

data/lib/active_public_resources/drivers/vimeo.rb

@@ -1,4 +1,5 @@
-require 'vimeo'
+require_relative '../oauth/vimeo.rb'
+require 'httparty'
 
 module ActivePublicResources
   module Drivers
@@ -18,18 +19,13 @@ module ActivePublicResources
       # @param [Hash] config_options the options which the vimeo gem requires
       # @option config_options [String] :consumer_key        Vimeo consumer key (required)
       # @option config_options [String] :consumer_secret     Vimeo consumer secret (required)
-      # @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,
-          [:consumer_key, :consumer_secret, :access_token, :access_token_secret])
-
-        @client = ::Vimeo::Advanced::Video.new(
+        validate_options(config_options, [:consumer_key, :consumer_secret])
+        @client = ActivePublicResources::OAuth::Vimeo.new(
           config_options[:consumer_key],
-          config_options[:consumer_secret],
-          token: config_options[:access_token],
-          secret: config_options[:access_token_secret]
+          config_options[:consumer_secret]
         )
+        @access_token = @client.get_access_token
       end
 
       # Perform search request to Vimeo with search criteria
@@ -84,16 +80,23 @@ module ActivePublicResources
         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,
-          :full_response  => 1,
-          :sort           => request_criteria.sort || "relevant",
-          :user_id        => nil,
-          :content_filter => request_criteria.content_filter || 'safe'
-        })
+        results = HTTParty.get('https://api.vimeo.com/videos',
+          query: {
+            query: request_criteria.query,
+            page: request_criteria.page || 1,
+            per_page: request_criteria.per_page || 25,
+            sort: 'relevant',
+            filter: 'content_rating',
+            filter_content_rating: 'safe'
+          },
+          headers: { "Authorization" => "Bearer #{@access_token}" }
+        )
 
-        return parse_results(request_criteria, results)
+        return parse_results(request_criteria, JSON.parse(results)) unless results.code == 401
+        if !@client.verify_token?(@access_token)
+          @access_token = @client.get_access_token
+          perform_request(request_criteria) if !@access_token.blank?
+        end
       end
 
     private
@@ -126,15 +129,16 @@ module ActivePublicResources
         @driver_response = DriverResponse.new(
           :criteria      => request_criteria,
           :next_criteria => next_criteria(request_criteria, results),
-          :total_items   => results['videos']['total'].to_i,
-          :items         => results['videos']['video'].map { |data| parse_video(data) }
+          :total_items   => results['total'].to_i,
+          :items         => results['data'].map { |data| parse_video(data) }
         )
       end
 
       def next_criteria(request_criteria, results)
-        page     = results['videos']['page'].to_i
-        per_page = results['videos']['perpage'].to_i
-        total    = results['videos']['total'].to_i
+        total = results['total'].to_i
+        page = results['page'].to_i
+        per_page = results['per_page'].to_i
+
         if ((page * per_page) < total)
           return RequestCriteria.new({
             :query    => request_criteria.query,
@@ -146,18 +150,18 @@ module ActivePublicResources
 
       def parse_video(data)
         video = ActivePublicResources::ResponseTypes::Video.new
-        video.id            = data['id']
-        video.title         = data['title']
-        video.description   = data['description']
-        video.thumbnail_url = data['thumbnails']['thumbnail'][0]['_content']
-        video.url           = data['urls']['url'][0]['_content']
-        video.embed_url     = "https://player.vimeo.com/video/#{data['id']}"
+        video.id            = "#{data['uri']}".gsub(/[^\d]/, '').to_i
+        video.title         = data['name']
+        video.description   = data['description'] || "No description found"
+        video.thumbnail_url = data['pictures']['sizes'][0]['link']
+        video.url           = data['link']
+        video.embed_url     = "https://player.vimeo.com/video/#{video.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
-        video.num_comments  = data['number_of_comments'].to_i
-        video.created_date  = Date.parse(data['upload_date'])
-        video.username      = data['owner']['display_name']
+        video.num_views     = data['stats']['plays'].to_i
+        video.num_likes     = data['metadata']['connections']['likes']['total'].to_i
+        video.num_comments  = data['metadata']['connections']['comments']['total'].to_i
+        video.created_date  = Date.parse(data['created_time'])
+        video.username      = data['user']['name']
         video.width         = 640
         video.height        = 360
 
@@ -172,13 +176,12 @@ module ActivePublicResources
         video.return_types << APR::ReturnTypes::Iframe.new(
           :driver => DRIVER_NAME,
           :remote_id => video.id,
-          :url    => "https://player.vimeo.com/video/#{data['id']}",
+          :url    => "https://player.vimeo.com/video/#{video.id}",
           :text   => video.title,
           :title  => video.title,
           :width  => 640,
           :height => 360
         )
-
         video
       end
 

data/lib/active_public_resources/drivers/youtube.rb

@@ -18,7 +18,7 @@ module ActivePublicResources
       def perform_request(request_criteria)
         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 channel"
+          raise ArgumentError, "You must specify at least a query or channel"
         end
 
         uri = URI('https://www.googleapis.com/youtube/v3/search')
@@ -110,6 +110,7 @@ module ActivePublicResources
       def next_criteria(request_criteria, results)
         if results['nextPageToken']
           return RequestCriteria.new({
+            channel_name: request_criteria.channel_name,
             query: request_criteria.query,
             page: results['nextPageToken'],
             per_page: results['pageInfo']['resultsPerPage'].to_i
@@ -120,25 +121,25 @@ module ActivePublicResources
       def parse_video(item)
         video_id = item['id']
         snippet = item['snippet']
-        statistics = item['statistics']
+        statistics = item['statistics'] ? item['statistics'] : {}
         details = item['contentDetails']
         video = APR::ResponseTypes::Video.new
         video.id             = video_id
         video.title          = snippet['title']
         video.description    = snippet['description']
         video.thumbnail_url  = snippet['thumbnails']['default']['url']
-        video.url            = "https://www.youtube.com/watch?v=#{video_id}&feature=youtube_gdata_player"
-        video.embed_url      = "https://www.youtube.com/embed/#{video_id}?feature=oembed&rel=0"
+        video.url            = "https://www.youtube-nocookie.com/embed/#{video_id}?feature=oembed&rel=0"
         video.duration       = ISO8601::Duration.new(details['duration']).to_seconds
         video.num_views      = statistics['viewCount'] ? statistics['viewCount'].to_i : 0
         video.num_likes      = statistics['likeCount'] ? statistics['likeCount'].to_i : 0
-        video.num_comments   = statistics['commentCount'] ? statistics['commentCount'] : 0
+        video.num_comments   = statistics['commentCount'] ? statistics['commentCount'].to_i : 0
         video.created_date   = Date.parse(snippet['publishedAt'])
         video.username       = snippet['channelTitle']
         video.width          = 640
         video.height         = 360
 
         # Return Types
+
         video.return_types << APR::ReturnTypes::Url.new(
           driver: DRIVER_NAME,
           remote_id: video.id,
@@ -146,10 +147,11 @@ module ActivePublicResources
           text: video.title,
           title: video.title
         )
+
         video.return_types << APR::ReturnTypes::Iframe.new(
           driver: DRIVER_NAME,
           remote_id: video.id,
-          url: video.embed_url,
+          url: video.url,
           text: video.title,
           title: video.title,
           width: 640,

data/lib/active_public_resources/oauth/vimeo.rb

@@ -0,0 +1,35 @@
+require 'httparty'
+require 'base64'
+
+module ActivePublicResources
+  module OAuth
+    class Vimeo
+      attr_reader :token
+
+      AUTHORIZE_URL = 'https://api.vimeo.com/oauth/authorize/client'
+      VERIFY_URL = 'https://api.vimeo.com/oauth/verify'
+
+      def initialize(consumer_key, consumer_secret)
+        @token = Base64.urlsafe_encode64("#{consumer_key}:#{consumer_secret}")
+      end
+
+      def get_access_token
+        response = HTTParty.post(
+          AUTHORIZE_URL,
+          body: { grant_type: 'client_credentials' },
+          headers: { "Authorization" => "Basic #{@token}" }
+        )
+        response['access_token']
+      end
+
+      def verify_token?(token)
+        response = HTTParty.get(
+          VERIFY_URL,
+          headers: { "Authorization" => "Bearer #{token}" }
+        )
+        response.code == 200
+      end
+
+    end
+  end
+end

data/lib/active_public_resources/version.rb

@@ -1,3 +1,3 @@
 module ActivePublicResources
-  VERSION = "0.2.4"
+  VERSION = "0.2.9"
 end

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

@@ -3,16 +3,16 @@ 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
+    it "should throw error when initializing 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)
+      driver.client.should be_an_instance_of(APR::OAuth::Vimeo)
     end
   end
 
@@ -71,5 +71,5 @@ describe APR::Drivers::Vimeo do
       item.height.should eq(360)
     end
   end
-  
+
 end

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

@@ -1,4 +1,7 @@
 require 'spec_helper'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
 
 describe APR::Drivers::Youtube do
 
@@ -8,45 +11,41 @@ describe APR::Drivers::Youtube 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")
+      }.to raise_error(StandardError, "You must specify at least a query or channel")
     end
 
-    it "should perform request", :vcr, :record => :none do
+    it "should perform request" do
+      stub_request(:get, "https://www.googleapis.com/youtube/v3/search?key=AIzaSyC-PDO3YHSXgfYkng3JjWp5G_HeNgJxkKM&maxResults=25&order=relevance&part=snippet&q=education&safeSearch=strict&type=video").
+        to_return(body: File.read('./active_public_resources/spec/lib/fixtures/youtube/education_search.json'), status: 200)
+      stub_request(:get, "https://www.googleapis.com/youtube/v3/videos?id=N6oIhdTzx9Q,HndV87XpkWg,S294zRodS_4,BnC6IABJXOI,xhN5Zkm82DA,8ZV_i37wxX8,nA1Aqp0sPQo,7CBKCG7HXjI,DdNAUJWJN08,imHfNDpBlCE,iG9CE55wbtY,_aB9Tg6SRA0,2lmv6ZDm0vw,nHHFGo161Os,Dvhuesh0D5s,Ky7H4CGPbvY,y_ZmM7zPLyI,CWmCrQVFujk,Cv6f-2Wlsxg,tOnDiuL2JmQ,qn9IMe5jmf0,dqTTojTija8,MhS6oqwwOhw,35VgsgICsjo,aV6w-zoacYk&key=AIzaSyC-PDO3YHSXgfYkng3JjWp5G_HeNgJxkKM&part=snippet,contentDetails,statistics").
+        to_return(body: File.read('./active_public_resources/spec/lib/fixtures/youtube/education_details_search.json'), status: 200)
       search_criteria = APR::RequestCriteria.new({:query => "education"})
       results = driver.perform_request(search_criteria)
       next_criteria = results.next_criteria
-      next_criteria.page.should eq(26)
+      next_criteria.page.should eq('CBkQAA')
       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.driver.should eq(APR::Drivers::Youtube::DRIVER_NAME)
-      rt_url.remote_id.should eq("y_ZmM7zPLyI")
-      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]
+      item.title.should eq("10 Ways to Get a Better EDUCATION")
+      item.description.should match /10 Ways to Get a Better EDUCATION/
+      item.thumbnail_url.should eq("https://i.ytimg.com/vi/N6oIhdTzx9Q/default.jpg")
+      item.url.should eq("https://www.youtube-nocookie.com/embed/N6oIhdTzx9Q?feature=oembed&rel=0")
+      item.duration.should eq(607.0)
+      item.num_views.should eq(22650)
+      item.num_likes.should eq(1576)
+      item.num_comments.should eq(175)
+      item.created_date.strftime("%Y-%m-%d").should eq("2020-04-28")
+      item.username.should eq("Alux.com")
+      item.return_types.count.should eq(1)
+
+      rt_iframe = item.return_types[0]
       rt_iframe.driver.should eq(APR::Drivers::Youtube::DRIVER_NAME)
-      rt_iframe.remote_id.should eq("y_ZmM7zPLyI")
+      rt_iframe.remote_id.should eq("N6oIhdTzx9Q")
       rt_iframe.return_type.should eq('iframe')
-      rt_iframe.url.should eq("https://www.youtube.com/embed/y_ZmM7zPLyI?feature=oembed")
-      rt_url.title.should eq("Why I Hate School But Love Education||Spoken Word")
+      rt_iframe.url.should eq("https://www.youtube-nocookie.com/embed/N6oIhdTzx9Q?feature=oembed&rel=0")
 
       item.width.should eq(640)
       item.height.should eq(360)

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

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'base64'
+require 'securerandom'
+
+describe APR::OAuth::Vimeo do
+
+  let(:client) { APR::OAuth::Vimeo.new(consumer_key, consumer_secret) }
+  let(:consumer_key) { 'key' }
+  let(:consumer_secret) { 'secret' }
+  let(:token) { Base64.urlsafe_encode64("#{consumer_key}:#{consumer_secret}") }
+  let(:access_token) { "#{SecureRandom.uuid}" }
+
+  describe ".initialize" do
+    it "should build a base64 encoded token" do
+      expect(client.token).to eq token
+    end
+  end
+
+  describe "#get_access_token" do
+    let(:response) { { "access_token" => access_token } }
+
+    it "should generate an access token" do
+      allow(HTTParty).to receive(:post) { response }
+      expect(client.get_access_token).to eq access_token
+    end
+  end
+
+  describe "#verify_token?" do
+    let(:response_ok) { double(:code => 200) }
+    let(:response_unauthorized) { double(:code => 401) }
+
+    it "should return 200 if token is verified" do
+      allow(HTTParty).to receive(:get) { response_ok }
+      expect(client.verify_token?(token)).to eq true
+    end
+
+    it "should return 401 if token is unauthorized" do
+      allow(HTTParty).to receive(:get) { response_unauthorized }
+      expect(client.verify_token?(token)).to eq false
+    end
+  end
+
+end