wildcard-pair 0.3.1

data/lib/wildcard-pair/Review.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby -wKU
+
+require 'active_model'
+require_relative 'hash_mappable.rb'
+require_relative 'Media.rb'
+
+module WildcardPair
+  class Review
+
+    include ActiveModel::Validations
+    include ActiveModel::Serializers::JSON
+    include WildcardPair::HashMappable
+    include WildcardPair::Media
+
+    # required fields
+    attr_accessor :title, :html_content
+    # optional fields
+    attr_accessor :publication_date, :abstract_content, :source, :author,
+      :updated_date, :product_name, :app_link_ios,
+      :app_link_android
+    attr_reader :rating, :media
+
+    validates :title, presence: true
+    validates :html_content, presence: true
+
+    validate :validate_media
+    validate :validate_rating
+
+    def metatags=(metatags)
+      if metatags.nil? || !metatags.is_a?(Hash)
+        return
+      end
+
+      #see what you can set based on metatags
+      self.title=metatags['title']
+      self.html_content=metatags['html']
+      self.abstract_content=metatags['description']
+      self.media=Media::Image.new image_url: metatags['image_url']
+      self.app_link_ios=metatags['applink_ios']
+      self.app_link_android=metatags['applink_android']
+    end
+
+    def media=(media)
+      if media.is_a? Video
+        @media = map_hash(media, Media::Video.new)
+      elsif media.is_a? Image
+        @media = map_hash(media, Media::Image.new)
+      elsif media.is_a? Hash
+        if media[:type] == 'video'
+          @media = map_hash(media, Media::Video.new)
+        elsif media[:type] == 'image'
+          @media = map_hash(media, Media::Image.new)
+        else
+          @media = media
+        end
+      end
+    end
+
+    def validate_media
+      if @media.nil? then return end
+
+      if !@media.is_a? Media or !@media.valid?
+        errors.add(:media, "Media is invalid")
+        return false
+      end
+    end
+
+    def rating=(rating)
+      @rating = map_hash(rating, WildcardPair::Rating.new)
+    end
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+
+    def attributes
+      instance_values
+    end
+
+    def validate_rating
+      if @rating.nil? then return end
+
+      if !@rating.is_a? Rating or !@rating.valid?
+        errors.add(:rating, "Rating is invalid")
+        return false
+      end
+    end
+
+    #exclude validation fields in the JSON output
+    def as_json(options={})
+      super(options.merge({:except => [:errors, :validation_context]}))
+    end
+
+    def to_json(options={})
+      if self.valid?
+        super(options)
+      else
+        raise "Video is not valid - please remedy the following errors:" << self.errors.messages.to_s
+      end    
+    end 
+
+  end
+end

data/lib/wildcard-pair/ReviewCard.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby -wKU
+
+require 'active_model'
+require_relative 'hash_mappable.rb'
+
+module WildcardPair
+  class ReviewCard
+    private
+
+    attr_accessor :review, :card_type, :pair_version
+
+    public
+
+    include ActiveModel::Validations
+    include ActiveModel::Serializers::JSON
+    include WildcardPair::HashMappable
+
+    attr_accessor :web_url
+    attr_reader :review, :card_type, :pair_version
+
+    validates :web_url, presence: true
+    validate :validate_review
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+
+      @card_type = 'review'
+
+      if !Gem.loaded_specs['wildcard-pair'].nil?
+        @pair_version = Gem.loaded_specs['wildcard-pair'].version.to_s
+      else
+        @pair_version = "unknown"
+      end
+    end
+
+    def attributes
+      instance_values
+    end
+
+    def populate_from_metatags(web_url)
+      @web_url=web_url
+      metatags = WildcardPair::ExtractMetaTags.extract(@web_url)
+
+      ##now that we've extracted metatags, let's create a Review 
+      self.review=WildcardPair::Review.new metatags: metatags
+    end
+
+    def review=(review)
+      @review = map_hash(review, WildcardPair::Review.new)
+    end
+
+    def validate_review
+      if @review.nil? or !@review.is_a? Review
+        errors.add(:review, "A review is required")
+        return
+      end
+
+      if !@review.valid?
+        @review.errors.each do |error, msg|
+           errors["review[%s]" % error] = msg
+        end
+      end
+    end
+
+    #exclude validation fields in the JSON output
+    def as_json(options={})
+      super(options.merge({:except => [:errors, :validation_context]}))
+    end
+
+    def to_json(options={})
+      if self.valid?
+        super(options)
+      else
+        raise "Review Card is not valid - please remedy the following errors:" << self.errors.messages.to_s
+      end    
+    end 
+
+  end
+end
+

data/lib/wildcard-pair/VideoCard.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby -wKU
+
+require 'active_model'
+require_relative 'hash_mappable.rb'
+require_relative 'Media.rb'
+
+module WildcardPair
+  class VideoCard
+    private
+
+    attr_accessor :media, :card_type, :pair_version
+
+    public
+
+    include ActiveModel::Validations
+    include ActiveModel::Serializers::JSON
+    include WildcardPair::HashMappable
+    include WildcardPair::Media
+
+    attr_accessor :web_url
+    attr_reader :media, :card_type, :pair_version
+
+    validates :web_url, presence: true
+    validate :validate_media
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+
+      @card_type = 'video'
+
+      if !Gem.loaded_specs['wildcard-pair'].nil?
+        @pair_version = Gem.loaded_specs['wildcard-pair'].version.to_s
+      else
+        @pair_version = "unknown"
+      end
+    end
+
+    def attributes
+      instance_values
+    end
+
+    def populate_from_metatags(web_url)
+      @web_url=web_url
+      metatags = WildcardPair::ExtractMetaTags.extract(@web_url)
+
+      ##now that we've extracted metatags, let's create a Video object with it
+      self.media=WildcardPair::Media::Video.new metatags: metatags
+    end
+
+    def media=(media)
+      @media = map_hash(media, WildcardPair::Media::Video.new)
+    end
+
+    def validate_media
+      if @media.nil? || !@media.is_a?(Video)
+        errors.add(:media, "A video is required")
+        return
+      end
+
+      if !@media.valid?
+        @media.errors.each do |error, msg|
+           errors["media[%s]" % error] = msg = msg
+        end
+      end
+    end
+
+    #exclude validation fields in the JSON output
+    def as_json(options={})
+      super(options.merge({:except => [:errors, :validation_context]}))
+    end
+
+    def to_json(options={})
+      if self.valid?
+        super(options)
+      else
+        raise "Video Card is not valid - please remedy the following errors:" << self.errors.messages.to_s
+      end    
+    end 
+
+  end
+end
+

data/lib/wildcard-pair/hash_mappable.rb

@@ -0,0 +1,18 @@
+module WildcardPair
+  module HashMappable
+    def map_hash(value, target)
+      if value.is_a? Hash
+        target.attributes = value
+        return target
+      else
+        return value
+      end 
+    end
+
+    def attributes=(hash)
+      hash.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/wildcard-pair/util/extract_metatags.rb

@@ -0,0 +1,99 @@
+require 'uri'
+require 'net/http'
+require 'nokogiri'
+
+module WildcardPair
+  module ExtractMetaTags
+
+    def self.get_metatag_key(attribute)
+
+    	if attribute.nil?
+    		return nil
+    	end
+
+    	case attribute
+    	when "twitter:title", "og:title"
+    		return "title"
+    	when "twitter:description", "og:description"
+    		return "description"
+    	when "twitter:image", "twitter:image:src", "og:image"
+    		return "image_url"
+    	when "og:price:amount", "product:price:amount"
+    		return "price"
+    	when "twitter:app:url:iphone", "al:ios:url"
+    		return "applink_ios"
+    	when "twitter:app:url:googleplay", "al:android:url"
+    		return "applink_android"
+    	when "og:video", "twitter:player"
+    		return "video_url"
+    	when "og:video:width", "twitter:player:width"
+    		return "video_width"
+    	when "og:video:height", "twitter:player:height"
+    		return "video_height"	
+    	else
+    		return nil
+    	end
+    end
+
+    def self.get_meta_key(meta_element)
+    	if !meta_element.is_a?(Hash)
+    		return nil
+    	end
+
+    	if (!meta_element['name'].nil?)
+    		return meta_element['name'].value
+    	elsif (!meta_element['property'].nil?)
+    		return meta_element['property'].value
+    	end
+   		
+    end
+
+    def self.get_meta_value(meta_element)
+    	if !meta_element.is_a?(Hash)
+    		return nil
+    	end
+
+    	if (!meta_element['content'].nil?)
+    		return meta_element['content'].value
+    	elsif (!meta_element['value'].nil?)
+    		return meta_element['value'].value
+    	end
+   		
+    end
+
+    private_class_method :get_meta_value, :get_meta_key, :get_metatag_key
+
+    public
+    def self.extract(web_url)
+        begin
+            metatags = Hash.new
+                 
+            if web_url.is_a?(String) && !web_url.nil? && !web_url.empty? 
+ 	   		     html_content = Net::HTTP.get(URI.parse(web_url))
+                 ##store html content in metatags hash
+                 metatags['html']=html_content
+ 	   		     doc = Nokogiri::HTML(html_content)
+ 	   		     
+                doc.xpath("//meta").each do |meta|
+        		      meta_key = get_meta_key(meta.attributes)
+        		      meta_tag_key = get_metatag_key(meta_key)
+
+        		      next if meta_tag_key.nil?
+                      next if metatags.has_key?(meta_tag_key)
+
+        		      metatags[meta_tag_key] = get_meta_value(meta.attributes) 
+        	    end
+
+            end
+
+            return metatags
+
+        rescue Exception => e
+            ## something bad happened during extraction, lets output message and return empty hash
+            puts e.message
+            return {}
+        end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: wildcard-pair
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Karthik Senthil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+description: Wildcard Pair SDK to facilitate partners being able to create cards for
+  their content
+email:
+- partners@trywildcard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wildcard-pair.rb
+- lib/wildcard-pair/Article.rb
+- lib/wildcard-pair/ArticleCard.rb
+- lib/wildcard-pair/Color.rb
+- lib/wildcard-pair/Media.rb
+- lib/wildcard-pair/Media/Image.rb
+- lib/wildcard-pair/Media/Video.rb
+- lib/wildcard-pair/Offer.rb
+- lib/wildcard-pair/Price.rb
+- lib/wildcard-pair/Product.rb
+- lib/wildcard-pair/ProductCard.rb
+- lib/wildcard-pair/ProductSearchCard.rb
+- lib/wildcard-pair/ProductSearchResult.rb
+- lib/wildcard-pair/Rating.rb
+- lib/wildcard-pair/Review.rb
+- lib/wildcard-pair/ReviewCard.rb
+- lib/wildcard-pair/VideoCard.rb
+- lib/wildcard-pair/hash_mappable.rb
+- lib/wildcard-pair/util/extract_metatags.rb
+homepage: http://trywildcard.com/dev
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Wildcard Pair Ruby SDK
+test_files: []