actv 1.3.11 → 1.4.0

data/lib/actv/client.rb

@@ -1,12 +1,18 @@
 require 'faraday'
 require 'actv/article'
 require 'actv/article_search_results'
+require 'actv/article_validator'
+require 'actv/asset_validator'
 require 'actv/asset'
+require 'actv/asset_factory'
+require 'actv/author'
+require 'actv/author_validator'
 require 'actv/configurable'
 require 'actv/error/forbidden'
 require 'actv/error/not_found'
 require 'actv/event'
 require 'actv/event_result'
+require 'actv/event_validator'
 require 'actv/asset_stats_result'
 require 'actv/evergreen'
 require 'actv/sub_event'
@@ -53,33 +59,10 @@ module ACTV
     end
     alias search assets
 
-    # Returns an asset with the specified ID in an array
-    #
-    # @authentication_required No
-    # @return [ACTV::Asset] The requested asset.
-    # @param id [String] An assset ID.
-    # @param options [Hash] A customizable set of options.
-    # @example Return the asset with the id BA288960-2718-4B20-B380-8F939596B123
-    #   ACTV.asset("BA288960-2718-4B20-B380-8F939596B123")
-    def asset(id, params={})
-      is_preview, params = params_include_preview? params
-
-      if is_preview
-        request_string = "/v2/assets/#{id}/preview"
-        response = get("#{request_string}.json", params)
-      else
-        request_string = "/v2/assets"
-        params = params.merge :id => id
-        response = post("#{request_string}.json", params)
-      end
-
-      if response[:body].is_a? Array
-        response[:body].map do |item|
-          ACTV::Asset.from_response body: item
-        end
-      else
-        [ACTV::Asset.from_response(response)]
-      end
+    def asset id, params={}
+      is_preview = params.delete(:preview) == "true"
+      response = request_response id, params, is_preview
+      asset_from_response response
     end
 
     # Returns an organizer with the specified ID
@@ -380,6 +363,39 @@ module ACTV
 
     private
 
+    def request_response id, params, is_preview
+      if is_preview
+        asset_response_with_preview id, params
+      else
+        asset_response_without_preview id, params
+      end
+    end
+
+    def asset_response_with_preview id, params
+      request_string = "/v2/assets/#{id}/preview"
+      get "#{request_string}.json", params
+    end
+
+    def asset_response_without_preview id, params
+      request_string = "/v2/assets"
+      params = params.merge :id => id
+      post "#{request_string}.json", params
+    end
+
+    def asset_from_response response
+      if response[:body].is_a? Array
+        collect_assets response
+      else
+        Array(ACTV::Asset.from_response response)
+      end
+    end
+
+    def collect_assets response
+      response[:body].map do |response|
+        ACTV::Asset.from_response body: response
+      end
+    end
+
     def find_by_endurance_id_params endurance_id
       awe_legacy_guid = 'DFAA997A-D591-44CA-9FB7-BF4A4C8984F1'
       params = {
@@ -405,6 +421,5 @@ module ACTV
       params = params.with_indifferent_access
       return params.delete(:preview) == "true", params
     end
-
   end
 end

data/lib/actv/event.rb

@@ -1,11 +1,15 @@
 require 'actv/asset'
 
 module ACTV
-  class Event < ACTV::Asset
+  class Event < Asset
     attr_reader :salesStartDate, :salesEndDate, :activityStartDate, :activityEndDate
     alias sales_start_date salesStartDate
     alias sales_end_date salesEndDate
 
+    def self.valid? response
+      ACTV::EventValidator.new(response).valid?
+    end
+
     def online_registration_available?
       if is_present?(self.registrationUrlAdr)
         if is_present?(self.legacy_data) && is_present?(self.legacy_data.onlineRegistration)
@@ -120,8 +124,6 @@ module ACTV
       place.timezoneOffset + place.timezoneDST
     end
 
-    ############
-
     def image_url
       defaultImage = 'http://www.active.com/images/events/hotrace.gif'
       image = ''
@@ -141,6 +143,10 @@ module ACTV
       image
     end
 
+    def is_event?
+      true
+    end
+
     alias online_registration? online_registration_available?
     alias reg_open? registration_open?
     alias reg_closed? registration_closed?
@@ -204,7 +210,6 @@ module ACTV
       return nil if time_string.nil? or time_string.empty?
       return Time.parse(time_string).utc
     end
-
   end
 end
 

data/lib/actv/event_validator.rb

@@ -0,0 +1,8 @@
+require 'actv/asset_validator'
+module ACTV
+  class EventValidator < AssetValidator
+    def valid?
+      category_is?('event') || taxonomy_has?('event')
+    end
+  end
+end

data/lib/actv/version.rb

@@ -1,3 +1,3 @@
 module ACTV
-  VERSION = "1.3.11"
+  VERSION = "1.4.0"
 end

data/spec/actv/article_spec.rb

@@ -1,44 +1,154 @@
 require 'spec_helper'
 
 describe ACTV::Article do
-  context "shoulda matchers" do
-    subject { ACTV::Article.new(assetGuid: 1) }
-
-    it { should respond_to :summary }
-    it { should respond_to :description }
-    it { should respond_to :by_line }
-    it { should respond_to :author_bio }
-    it { should respond_to :author_photo }
-    it { should respond_to :source }
-    it { should respond_to :type }
-    it { should respond_to :image }
-    it { should respond_to :subtitle }
-    it { should respond_to :footer }
-    it { should respond_to :inline_ad }
-    it { should respond_to :inline_ad? }
+  let(:descriptions) { [ { description: "article source", descriptionType: { descriptionTypeId: "1", descriptionTypeName: "articleSource" } },
+                         { description: "article subtitle", descriptionType: { descriptionTypeId: "2", descriptionTypeName: "subtitle" } },
+                         { description: "by Yason", descriptionType: { descriptionTypeId: "3", descriptionTypeName: "articleByLine" } },
+                         { description: "article footer", descriptionType: { descriptionTypeId: "4", descriptionTypeName: "footer" } } ] }
+  let(:asset_images) { [] }
+  let(:asset_categories) { [] }
+  let(:asset_tags) { [] }
+  let(:asset_references) { [] }
+  let(:response) { { assetGuid: 1,
+                     assetDescriptions: descriptions,
+                     assetTags: asset_tags,
+                     assetImages: asset_images,
+                     assetCategories: asset_categories,
+                     assetReferences: asset_references } }
+  subject(:article) { ACTV::Article.new response }
+
+  describe '#self.valid?' do
+    subject(:valid?) { ACTV::Article.valid? response }
+    context 'when the category name is articles' do
+      let(:asset_categories) { [ { category: { categoryName: "Articles", categoryTaxonomy: "" } } ] }
+      it { should be_true }
+    end
+    context 'when the category taxonomy is articles' do
+      let(:asset_categories) { [ { category: { categoryName: "", categoryTaxonomy: "Creative Work/Articles" } } ] }
+      it { should be_true }
+    end
+    context 'when there is no category taxonomy or name' do
+      it { should be_false }
+    end
   end
 
-  describe '#inline_ad?' do
-    context 'if inlindead is set to true' do
-      let(:article) { ACTV::Article.new(assetGuid: 1, assetTags: [ { tag: { tagId: '1', tagName: 'true', tagDescription: 'inlinead' } } ]) }
-      it 'should return true' do
-        article.inline_ad?.should eq true
+  describe '#source' do
+    context 'when an articleSource description exists' do
+      its(:source) { should eq "article source" }
+    end
+    context 'when an articleSource description does not exist' do
+      let(:descriptions) { [] }
+      its(:source) { should be_nil }
+    end
+  end
+
+  describe '#type' do
+    context 'when an articleType tag description exists' do
+      let(:asset_tags) { [ { tag: { tagId: '2', tagName: 'mediagallery', tagDescription: 'articleType' } } ] }
+      its(:type) { should eq "mediagallery" }
+    end
+    context 'when an articleType tag description does not exist' do
+      its(:type) { should be_nil }
+    end
+  end
+
+  describe '#media_gallery?' do
+    context 'when the articleType tag is mediagallery' do
+      let(:asset_tags) { [ { tag: { tagId: '2', tagName: 'mediagallery', tagDescription: 'articleType' } } ] }
+      its(:media_gallery?) { should be_true }
+    end
+    context 'when the articleType tag is not mediagallery' do
+      its(:media_gallery?) { should be_false }
+    end
+  end
+
+  describe '#image' do
+    context 'when article has an image named image2' do
+      let(:asset_images) { [ { imageName: "image2" } ] }
+      it 'returns the image' do
+        expect(article.image).to be_a ACTV::AssetImage
       end
     end
+    context 'when article does not have an image named image2' do
+      it 'returns nil' do
+        expect(article.image).to be_nil
+      end
+    end
+  end
 
+  describe '#subtitle' do
+    context 'when a subtitle description exists' do
+      its(:subtitle) { should eq "article subtitle" }
+    end
+    context 'when a subtitle description does not exist' do
+      let(:descriptions) { [] }
+      its(:subtitle) { should be_nil }
+    end
+  end
+
+  describe '#footer' do
+    context 'when a footer description exists' do
+      its(:footer) { should eq "article footer" }
+    end
+    context 'when a footer description does not exist' do
+      let(:descriptions) { [] }
+      its(:footer) { should be_nil }
+    end
+  end
+
+  describe '#inline_ad?' do
+    context 'if inlindead is set to true' do
+      let(:asset_tags) { [ { tag: { tagId: '1', tagName: 'true', tagDescription: 'inlinead' } } ] }
+      its(:inline_ad?) { should be_true }
+    end
     context 'if inlindead is set to false' do
-      let(:article) { ACTV::Article.new(assetGuid: 1, assetTags: [ { tag: { tagId: '1', tagName: 'false', tagDescription: 'inlinead' } } ]) }
-      it 'should return false' do
-        article.inline_ad?.should eq false
+      let(:asset_tags) { [ { tag: { tagId: '2', tagName: 'false', tagDescription: 'inlinead' } } ] }
+      its(:inline_ad?) { should be_false }
+    end
+    context 'if inlindead is not set' do
+      its(:inline_ad?) { should be_true }
+    end
+  end
+
+  describe '#author' do
+    context 'when an author reference exists' do
+      let(:asset_references) { [ { referenceAsset: { assetGuid: "123" }, referenceType: { referenceTypeName: "author" } } ] }
+      before do
+        stub_request(:post, "http://api.amp.active.com/v2/assets.json").
+          to_return(body: fixture("valid_author.json"))
       end
+      context 'when the author exists in a3pi' do
+        its(:author) { should be_a ACTV::Author }
+      end
+      context 'when the author does not exist in a3pi' do
+        before do
+          allow(ACTV).to receive(:asset).and_raise ACTV::Error::NotFound
+        end
+        its(:author) { should be_a ACTV::Author }
+      end
+    end
+    context 'when an author reference does not exist' do
+      its(:author) { should be_a ACTV::Author }
     end
+  end
 
-    context 'if inlindead is not set' do
-      let(:article) { ACTV::Article.new assetGuid: 1 }
+  describe '#is_article?' do
+    its(:is_article?) { should be_true }
+  end
 
-      it 'should return true' do
-        article.inline_ad?.should eq true
+  describe '#author_from_by_line' do
+    context 'when a by line is present' do
+      context 'when a match is found' do
+        its(:author_name_from_by_line) { should eq "Yason" }
       end
+      context 'when a match is not found' do
+        let(:descriptions) { [] }
+        its(:author_name_from_by_line) { should be_nil }
+      end
+    end
+    context 'when a by line is not present' do
+      let(:descriptions) { [] }
+      its(:author_name_from_by_line) { should be_nil }
     end
   end
-end
+end

data/spec/actv/article_validator_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ACTV::ArticleValidator do
+  let(:asset_categories) { [] }
+  let(:response) { { assetGuid: 1, assetCategories: asset_categories } }
+  subject(:validator) { ACTV::ArticleValidator.new(response).valid? }
+
+  describe '#valid?' do
+    context 'when the response is valid' do
+      context 'because the category name is valid' do
+        let(:asset_categories) { [ { category: { categoryName: "Articles", categoryTaxonomy: "" } } ] }
+        it { should be_true }
+      end
+      context 'because the category taxonomy is valid' do
+        let(:asset_categories) { [ { category: { categoryName: "", categoryTaxonomy: "Person/Articles" } } ] }
+        it { should be_true }
+      end
+    end
+    context 'when the response is not valid' do
+      it { should be_false }
+    end
+  end
+end

data/spec/actv/asset_component_spec.rb

@@ -8,11 +8,10 @@ describe ACTV::AssetComponent do
   describe "#prices" do
     before(:each) do
       stub_post("/v2/assets.json").with(:body => {"id"=>true}).
-      to_return(body: fixture("valid_component_asset.json"), headers: { content_type: "application/json; charset=utf-8" })
+        to_return(body: fixture("valid_component_asset.json"), headers: { content_type: "application/json; charset=utf-8" })
     end
 
     it 'returns the prices associated with the component' do
-      expect(subject.prices).to be_an(Array)
       expect(subject.prices.first).to be_an(ACTV::AssetPrice)
     end
   end

data/spec/actv/asset_factory_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe ACTV::AssetFactory do
+  let(:category_name) { "" }
+  let(:category_taxonomy) { "" }
+  let(:response) { {assetGuid: "111",
+                    assetCategories: [{category: {categoryName: category_name,
+                                                  categoryTaxonomy: category_taxonomy}}]} }
+  subject(:asset) { ACTV::AssetFactory.new(response).asset }
+
+  describe '#asset' do
+    context 'the response is not an author, event or article' do
+      it { should be_a ACTV::Asset }
+    end
+    context 'the response has an article category' do
+      let(:category_name) { "Articles" }
+      it { should be_a ACTV::Article }
+    end
+    context 'the response has an article taxonomy' do
+      let(:category_taxonomy) { "Running/Articles" }
+      it { should be_a ACTV::Article }
+    end
+    context 'the response has an event category' do
+      let(:category_name) { "Event" }
+      it { should be_a ACTV::Event }
+    end
+    context 'the response has an event taxonomy' do
+      let(:category_taxonomy) { "Race/Event" }
+      it { should be_a ACTV::Event }
+    end
+    context 'the response has an author category' do
+      let(:category_name) { "Author" }
+      it { should be_a ACTV::Author }
+    end
+    context 'the response has an author taxonomy' do
+      let(:category_taxonomy) { "Running/Author" }
+      it { should be_a ACTV::Author }
+    end
+  end
+end

data/spec/actv/asset_reference_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+describe ACTV::AssetReference do
+  let(:asset_guid) { "123" }
+  let(:reference_type_name) { "Meow" }
+  let(:reference_hash) { {referenceAsset: {assetGuid: asset_guid},
+                    referenceType: {referenceTypeName: reference_type_name}} }
+  subject(:asset_reference) { ACTV::AssetReference.new reference_hash }
+
+  describe '#id' do
+    it 'returns a guid' do
+      expect(asset_reference.id).to eq asset_guid
+    end
+  end
+
+  describe '#type' do
+    it 'returns a type' do
+      expect(asset_reference.type).to eq reference_type_name
+    end
+  end
+end

data/spec/actv/asset_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'pry'
 
 describe ACTV::Asset do
 
@@ -190,6 +189,32 @@ describe ACTV::Asset do
     end
   end
 
+  describe "is_event?" do
+    before(:each) do
+        stub_post("/v2/assets.json").with(:body => {"id"=>"valid_event"}).
+          to_return(body: fixture("valid_event.json"))
+    end
+
+    it "should return true if the asset has Events as an assetCategory" do
+      asset = ACTV.asset('valid_event').first
+      asset.is_event?.should be_true
+    end
+
+    it "should return true if the asset has no assetCategories but the sourceSystem is Active.com Articles" do
+      asset = ACTV.asset('valid_event').first
+      asset.stub(:assetCategories).and_return([])
+      asset.is_event?.should be_true
+    end
+
+    it "should return false if no assetCategory of Event" do
+      stub_post("/v2/assets.json").with(:body => {"id"=>"valid_article"}).
+        to_return(body: fixture("valid_article.json"))
+
+      asset = ACTV.asset('valid_article').first
+      asset.is_event?.should be_false
+    end
+  end
+
   describe "is_article?" do
     before(:each) do
         stub_post("/v2/assets.json").with(:body => {"id"=>"valid_article"}).
@@ -282,7 +307,7 @@ describe ACTV::Asset do
         end
       end
 
-      context "and articles_source? returns true" do
+      context "and acm? returns true" do
         let(:asset) { ACTV::Asset.new assetGuid: 1, sourceSystem: {legacyGuid: "CA4EA0B1-7377-470D-B20D-BF6BEA23F040"} }
 
         context 'and kids_interest? is true' do
@@ -309,7 +334,7 @@ describe ACTV::Asset do
           asset.stub activenet?: false
           asset.stub awcamps?: false
           asset.stub awcamps30?: false
-          asset.stub articles_source?: false
+          asset.stub acm?: false
         end
 
         it 'evaluates to false' do
@@ -485,4 +510,27 @@ describe ACTV::Asset do
     end
   end
 
+  describe '#references' do
+    let(:asset_references) { [] }
+    let(:response) { { assetGuid: 1, assetReferences: asset_references } }
+    let(:asset) { ACTV::Asset.new response }
+    context 'when there are asset references' do
+      let(:asset_references) { [ { referenceAsset: { assetGuid: "123" },
+                                   referenceType: { referenceTypeName: "author" } } ] }
+      it 'returns an array of asset reference objects' do
+        expect(asset.references.first).to be_a ACTV::AssetReference
+      end
+    end
+    context 'when there are no asset references' do
+      it 'returns an empty array' do
+        expect(asset.references).to be_empty
+      end
+    end
+    context 'when there is no asset references field' do
+      let(:response) { { assetGuid: 1 } }
+      it 'returns an empty array' do
+        expect(asset.references).to be_empty
+      end
+    end
+  end
 end