actv 1.1.0

data/lib/actv/asset_channel.rb

@@ -0,0 +1,13 @@
+require 'actv/channel'
+
+module ACTV
+  class AssetChannel < Base
+
+    attr_reader :sequence
+
+    def channel
+      @channel ||= ACTV::Channel.new(@attrs[:channel]) unless @attrs[:channel].nil?
+    end
+
+  end
+end

data/lib/actv/asset_component.rb

@@ -0,0 +1,8 @@
+module ACTV
+  class AssetComponent < Base
+
+    attr_reader :assetGuid
+
+    alias asset_guid assetGuid
+  end
+end

data/lib/actv/asset_description.rb

@@ -0,0 +1,15 @@
+require 'actv/asset_description_type'
+
+module ACTV
+  class AssetDescription < Base
+
+    attr_reader :description
+
+    def type
+        @description_type ||= ACTV::AssetDescriptionType.new(@attrs[:descriptionType]) unless @attrs[:descriptionType].nil?
+    end
+    alias description_type type
+    alias descriptionType type
+
+  end
+end

data/lib/actv/asset_description_type.rb

@@ -0,0 +1,12 @@
+require 'actv/identity'
+
+module ACTV
+  class AssetDescriptionType < ACTV::Identity
+
+    attr_reader :descriptionTypeId, :descriptionTypeName
+
+    alias id descriptionTypeId
+    alias name descriptionTypeName
+
+  end
+end

data/lib/actv/asset_image.rb

@@ -0,0 +1,13 @@
+module ACTV
+  class AssetImage < Base
+
+    attr_reader :imageUrlAdr, :imageName, :imageCaptionTxt, :linkUrl, :linkTarget
+
+    alias url     imageUrlAdr
+    alias name    imageName
+    alias caption imageCaptionTxt
+    alias link    linkUrl
+    alias target  linkTarget
+
+  end
+end

data/lib/actv/asset_legacy_data.rb

@@ -0,0 +1,20 @@
+require 'actv/identity'
+
+module ACTV
+  class AssetLegacyData < Base
+
+    attr_reader :assetTypeId, :typeName, :onlineRegistration, :seoUrl, 
+      :substitutionUrl, :isSearchable, :createdDate, :modifiedDate
+
+    alias id assetTypeId
+    alias type_name typeName
+    alias online_registration? onlineRegistration
+    alias online_registration onlineRegistration
+    alias seo_url seoUrl
+    alias substitution_url substitutionUrl
+    alias is_searchable? isSearchable
+    alias created_at createdDate
+    alias updated_at modifiedDate
+
+  end
+end

data/lib/actv/asset_price.rb

@@ -0,0 +1,11 @@
+module ACTV
+  class AssetPrice < Base
+
+    attr_reader :effectiveDate, :priceAmt, :maxPriceAmt, :minPriceAmt
+
+    alias effective_date effectiveDate
+    alias amount priceAmt
+    alias max_amount maxPriceAmt
+    alias min_amount minPriceAmt
+  end
+end

data/lib/actv/asset_seo_url.rb

@@ -0,0 +1,5 @@
+module ACTV
+  class AssetSeoUrl < Base
+    attr_reader :seoSystemName, :statusCode, :urlAdr
+  end
+end

data/lib/actv/asset_status.rb

@@ -0,0 +1,17 @@
+require 'actv/identity'
+
+module ACTV
+  class AssetStatus < ACTV::Identity
+
+    attr_reader :assetStatusId, :assetStatusName, :isSearchable, :isDeleted,
+      :createdDate, :modifiedDate
+
+    alias id assetStatusId
+    alias name assetStatusName
+    alias is_searchable? isSearchable
+    alias is_deleted? isDeleted
+    alias created_at createdDate
+    alias updated_at modifiedDate
+
+  end
+end

data/lib/actv/asset_tag.rb

@@ -0,0 +1,9 @@
+require 'actv/tag'
+
+module ACTV
+  class AssetTag < Base
+    def tag
+      @tag ||= ACTV::Tag.new(@attrs[:tag]) unless @attrs[:tag].nil?
+    end
+  end
+end

data/lib/actv/asset_topic.rb

@@ -0,0 +1,11 @@
+require 'actv/topic'
+
+module ACTV
+  class AssetTopic < Base
+    attr_reader :sequence
+
+    def topic
+      @topic ||= ACTV::Topic.new(@attrs[:topic]) unless @attrs[:topic].nil?
+    end
+  end
+end

data/lib/actv/base.rb

@@ -0,0 +1,148 @@
+require 'forwardable'
+require 'actv/null_object'
+require 'uri'
+
+module ACTV
+  class Base
+    extend Forwardable
+    attr_reader :attrs
+    alias body attrs
+    def_delegators :attrs, :delete, :update
+
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    #
+    # @overload self.    attr_reader(attr)
+    #   @param attr [Symbol]
+    # @overload self.    attr_reader(attrs)
+    #   @param attrs [Array<Symbol>]
+    def self.attr_reader(*attrs)
+      attrs.each do |attribute|
+        define_attribute_method(attribute)
+        define_predicate_method(attribute)
+      end
+    end
+
+    def self.object_attr_reader(klass, key1, key2=nil)
+      define_attribute_method(key1, kass, key2)
+      define_predicate_method(key1)
+    end
+
+    def self.uri_attr_reader(*attrs)
+      attrs.each do |uri_key|
+        array = uri_key.to_s.split("_")
+        index = array.index("uri")
+        array[index] = "url"
+        url_key = array.join("_").to_sym
+        define_uri_method(uri_key, url_key)
+        define_predicate_method(uri_key, url_key)
+
+        alias_method(url_key, uri_key)
+        alias_method("#{url_key}?", "#{uri_key}?")
+      end
+    end
+
+    def self.define_uri_method(key1, key2)
+      define_method(key1) do
+        memoize(key1) do
+          ::URI.parse(@attrs[key2]) if @attrs[key2]
+        end
+      end
+    end
+
+    def self.define_attribute_method(key1, klass=nil, key2=nil)
+      define_method(key1) do
+        memoize(key1) do
+          if klass.nil?
+            @attrs[key1]
+          else
+            if @attrs[key1]
+              if key2.nil?
+                ACTV.const_get(klass).new(@attrs[key1])
+              else
+                attrs = @attrs.dup
+                value = attrs.delete(key1)
+                ACTV.const_get(klass).new(value.update(key2 => attrs))
+              end
+            else
+              ACTV::NullObject.instance
+            end
+          end
+        end
+      end
+    end
+
+    def self.define_predicate_method(key1, key2=key1)
+      define_method(:"#{key1}?") do
+        !!@attrs[key2]
+      end
+    end
+
+    def self.from_response(response={})
+      new(response[:body])
+    end
+
+    def initialize(attrs={})
+      @attrs = attrs || {}
+    end
+
+    def [](method)
+      send(method)
+    rescue NoMethodError
+      nil
+    end
+
+    def memoize(key, &block)
+      ivar = :"@#{key}"
+      return instance_variable_get(ivar) if instance_variable_defined?(ivar)
+      result = block.call
+      instance_variable_set(ivar, result)
+    end
+
+    def method_missing(meth, *args, &block)
+      if @attrs && @attrs.has_key?(meth)
+        @attrs[meth]
+      elsif meth.to_s.include?('=') and !args.empty?
+        @attrs[meth[0..-2].to_sym] = args.first
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth, *args)
+      if @attrs && @attrs.has_key?(meth)
+        true
+      else
+        super
+      end
+    end
+
+    # Creation of object hash when sending request to soap
+    def to_hash
+      hash = {}
+      hash["attrs"] = @attrs
+
+      self.instance_variables.keep_if { |key| key != :@attrs }.each do |var|
+        val = self.instance_variable_get(var)
+        hash["attrs"][var.to_s.delete("@").to_sym] = val.to_hash if val.is_a? ACTV::Base
+      end
+
+      hash["attrs"]
+    end
+
+  protected
+
+    # @param attr [Symbol]
+    # @param other [ACTV::Base]
+    # @return [Boolean]
+    def attr_equal(attr, other)
+      self.class == other.class && !other.send(attr).nil? && send(attr) == other.send(attr)
+    end
+
+    # @param other [ACTV::Base]
+    # @return [Boolean]
+    def attrs_equal(other)
+      self.class == other.class && !other.attrs.empty? && attrs == other.attrs
+    end
+
+  end
+end

data/lib/actv/channel.rb

@@ -0,0 +1,13 @@
+require 'actv/identity'
+
+module ACTV
+  class Channel < ACTV::Identity
+
+    attr_reader :channelId, :channelName, :channelDsc
+
+    alias id channelId
+    alias name channelName
+    alias description channelDsc
+
+  end
+end

data/lib/actv/client.rb

@@ -0,0 +1,330 @@
+require 'faraday'
+require 'actv/article'
+require 'actv/article_search_results'
+require 'actv/asset'
+require 'actv/configurable'
+require 'actv/error/forbidden'
+require 'actv/error/not_found'
+require 'actv/event'
+require 'actv/event_result'
+require 'actv/evergreen'
+require 'actv/sub_event'
+require 'actv/search_results'
+require 'actv/event_search_results'
+require 'actv/popular_interest_search_results'
+require 'actv/user'
+require 'simple_oauth'
+
+module ACTV
+  # Wrapper for the ACTV REST API
+  #
+  # @note
+  class Client
+    include ACTV::Configurable
+
+    attr_reader :oauth_token
+
+    # Initialized a new Client object
+    #
+    # @param options [Hash]
+    # @return[ACTV::Client]
+    def initialize(options={})
+      ACTV::Configurable.keys.each do |key|
+        instance_variable_set("@#{key}", options[key] || ACTV.options[key])
+      end
+    end
+
+    # Returns assets that match a specified query.
+    #
+    # @authentication_required No
+    # @param q [String] A search term.
+    # @param options [Hash] A customizable set of options.
+    # @return [ACTV::SearchResults] Return assets that match a specified query with search metadata
+    # @example Returns assets related to running
+    #   ACTV.assets('running')
+    #   ACTV.search('running')
+    def assets(q, params={})
+      response = get("/v2/search.json", params.merge(query: q))
+      ACTV::SearchResults.from_response(response)
+    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={})
+      response = get("/v2/assets/#{id}.json", params)
+
+      if response[:body].is_a? Array 
+        results = []
+        response[:body].each do |item|
+          results << ACTV::Asset.from_response({body: item})
+        end
+        results
+      else        
+        [ACTV::Asset.from_response(response)]
+      end    
+    end
+    
+    # Returns an asset with the specified url path
+    #
+    # @authentication_required No
+    # @return [ACTV::Asset] The requested asset
+    # @param path [String]
+    # @example Return an asset with the url http://www.active.com/miami-fl/running/miami-marathon-and-half-marathon-2014
+    #   ACTV.asset_by_path("http://www.active.com/miami-fl/running/miami-marathon-and-half-marathon-2014")
+    def find_asset_by_url(url)
+      url_md5 = Digest::MD5.hexdigest(url)
+      response = get("/v2/seourls/#{url_md5}?load_asset=true")
+
+      ACTV::Asset.from_response(response)
+    end
+
+    # Returns articles that match a specified query.
+    #
+    # @authentication_required No
+    # @param q [String] A search term.
+    # @param options [Hash] A customizable set of options.
+    # @return [ACTV::SearchResults] Return articles that match a specified query with search metadata
+    # @example Returns articles related to running
+    #   ACTV.articles('running')
+    #   ACTV.articles('running')
+    def articles(q, params={})
+      response = get("/v2/search.json", params.merge({query: q, category: 'articles'}))
+      ACTV::ArticleSearchResults.from_response(response)
+    end
+
+    # Returns an article with the specified ID
+    #
+    # @authentication_required No
+    # @return [ACTV::Article] The requested article.
+    # @param id [String] An article ID.
+    # @param options [Hash] A customizable set of options.
+    # @example Return the article with the id BA288960-2718-4B20-B380-8F939596B123
+    #   ACTV.article("BA288960-2718-4B20-B380-8F939596B123")
+    def article(id)
+      response = get("/v2/assets/#{id}.json")
+      article = ACTV::Article.from_response(response)
+      article.is_article? ? article : nil
+    end
+
+    def events(q, params={})
+      response = get("/v2/search.json", params.merge({query: q, category: 'event'}))
+      ACTV::EventSearchResults.from_response(response)
+    end
+
+    def event(id)
+      response = get("/v2/assets/#{id}.json")
+      event = ACTV::Event.from_response(response)
+      event = ACTV::Evergreen.new(event) if event.evergreen?
+      event.is_article? ? nil : event
+    end
+
+    # Returns popular assets that match a specified query.
+    #
+    # @authentication_required No
+    # @param options [Hash] A customizable set of options.
+    # @return [ACTV::SearchResults] Return events that match a specified query with search metadata
+    # @example Returns articles related to running
+    #   ACTV.popular_events()
+    #   ACTV.popular_events("topic:running")
+    def popular_events(params={})
+      response = get("/v2/events/popular", params)
+      ACTV::SearchResults.from_response(response)
+    end
+
+    # Returns upcoming assets that match a specified query.
+    #
+    # @authentication_required No
+    # @param options [Hash] A customizable set of options.
+    # @return [ACTV::SearchResults] Return events that match a specified query with search metadata
+    # @example Returns articles related to running
+    #   ACTV.upcoming_events()
+    #   ACTV.upcoming_events("topic:running")
+    def upcoming_events(params={})
+      response = get("/v2/events/upcoming", params)
+      ACTV::SearchResults.from_response(response)
+    end
+
+    # Returns popular assets that match a specified query.
+    #
+    # @authentication_required No
+    # @param options [Hash] A customizable set of options.
+    # @return [ACTV::SearchResults] Return events that match a specified query with search metadata
+    # @example Returns articles related to running
+    #   ACTV.popular_articles()
+    #   ACTV.popular_articles("topic:running")
+    def popular_articles(params={})
+      response = get("/v2/articles/popular", params)
+      ACTV::ArticleSearchResults.from_response(response)
+    end
+
+    # Returns popular interests
+    #
+    # @authentication_required No
+    # @param options [Hash] A customizable set of options.
+    # @return [ACTV::PopularInterestSearchResults] Return intersts
+    # @example Returns most popular interests
+    #   ACTV.popular_interests()
+    #   ACTV.popular_interests({per_page: 8})
+    def popular_interests(params={}, options={})
+      response = get("/interest/_search", params, options)
+      ACTV::PopularInterestSearchResults.from_response(response)
+    end
+
+    # Returns popular searches
+    #
+    # @authentication_required No
+    # @param options [Hash] A customizable set of options.
+    # @return [ACTV::PopularSearchSearchResults] Return searches
+    # @example Returns most popular searches
+    #   ACTV.popular_searches()
+    #   ACTV.popular_searches({per_page: 8})
+    def popular_searches(options={})
+      #response = get("/v2/articles/popular", params)
+      #ACTV::ArticleSearchResults.from_response(response)
+      ["Couch to 5k","Kids' Camps","Swimming Classes","Half Marathons in Southern CA","Gyms in Solana Beach","Dignissim Qui Blandit","Dolore Te Feugait","Lorem Ipsum","Convnetio Ibidem","Aliquam Jugis"]
+    end
+
+    # Returns a result with the specified asset ID and asset type ID
+    #
+    # @authentication_required No
+    # @return [ACTV::EventResult] The requested event result.
+    # @param assetId [String] An asset ID.
+    # @param assetTypeId [String] An asset type ID.
+    # @example Return the result with the assetId 286F5731-9800-4C6E-ADD5-0E3B72392CA7 and assetTypeId 3BF82BBE-CF88-4E8C-A56F-78F5CE87E4C6
+    #   ACTV.event_results("286F5731-9800-4C6E-ADD5-0E3B72392CA7","3BF82BBE-CF88-4E8C-A56F-78F5CE87E4C6")
+    def event_results(assetId, assetTypeId, options={})
+      begin
+        response = get("/api/v1/events/#{assetId}/#{assetTypeId}.json", {}, options)
+        ACTV::EventResult.from_response(response)
+      rescue
+        nil
+      end
+    end
+
+    # Returns the currently logged in user
+    #
+    # @authentication_required Yes
+    # @return [ACTV::User] The requested current user.
+    # @param options [Hash] A customizable set of options.
+    # @example Return current_user if authentication was susccessful
+    #   ACTV.me
+    def me(params={})
+      response = get("/v2/me.json", params)
+      user = ACTV::User.from_response(response)
+      user.access_token =  @oauth_token
+      user
+    end
+
+    def update_me(user, params={})
+      response = put("/v2/me.json", params.merge(user))
+      user = ACTV::User.from_response(response)
+      user.access_token =  @oauth_token
+      user
+    end
+
+    def user_name_exists?(user_name, params={})
+      get("/v2/users/user_name/#{user_name}", params)[:body][:exists]
+    end
+
+    def display_name_exists?(display_name, params={})
+      get("/v2/users/display_name/#{URI.escape(display_name)}", params)[:body][:exists]
+    end
+
+    def is_advantage_member?(options={})
+      get("/v2/me/is_advantage_member", options)[:body][:is_advantage_member]
+    end
+
+    def avatar_url(options={})
+      get("/v2/me/avatar_url", options)[:body][:avatar_url]
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={}, options={})
+      request(:post, path, params, options)
+    end
+
+    # Perform an HTTP UPDATE request
+    def put(path, params={}, options={})
+      request(:put, path, params, options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, params={}, options={})
+      request(:delete, path, params, options)
+    end
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(@endpoint, @connection_options.merge(:builder => @middleware))
+    end
+
+    # Perform an HTTP Request
+    def request(method, path, params, options)
+      uri = options[:endpoint] || @endpoint
+      uri = URI(uri) unless uri.respond_to?(:host)
+      uri += path
+      request_headers = {}
+      params[:api_key] = @api_key unless @api_key.nil?
+
+      if self.credentials?
+        # When posting a file, don't sign any params
+        signature_params = if [:post, :put].include?(method.to_sym) && params.values.any?{|value| value.is_a?(File) || (value.is_a?(Hash) && (value[:io].is_a?(IO) || value[:io].is_a?(StringIO)))}
+          {}
+        else
+          params
+        end
+        authorization = SimpleOAuth::Header.new(method, uri, signature_params, credentials)
+        request_headers[:authorization] = authorization.to_s.sub('OAuth', "Bearer")
+      end
+      connection.url_prefix = options[:endpoint] || @endpoint
+      connection.run_request(method.to_sym, path, nil, request_headers) do |request|
+        unless params.empty?
+          case request.method
+          when :post, :put
+            request.body = params
+          else
+            request.params.update(params)
+          end
+        end
+        yield request if block_given?
+      end.env
+    rescue Faraday::Error::ClientError
+      raise ACTV::Error::ClientError
+    end
+    # Check whether credentials are present
+    #
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+  private
+
+    # Credentials hash
+    #
+    # @return [Hash]
+    def credentials
+      {
+        # :consumer_key => @consumer_key,
+        # :consumer_secret => @consumer_secret,
+        :token => @oauth_token
+        # :token_secret => @oauth_token_secret,
+      }
+    end
+
+  end
+end