Active 0.0.42 → 0.1.7

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+tmp/*

data/.irbrc

@@ -0,0 +1,21 @@
+# Project-specific .irbrc file
+
+# In order for this file to be picked up automatically by irb, you need to add
+# the following code (or equivalent) to your own ~/.irbrc file:
+
+  # if Dir.pwd != File.expand_path("~")
+  #   local_irbrc = File.expand_path '.irbrc'
+  #   if File.exist? local_irbrc
+  #     puts "Loading #{local_irbrc}"
+  #     load local_irbrc
+  #   end
+  # end
+
+# When irb is started within this project folder (read: during gem development)
+# this file will add lib/ to the load_path and require the gem.
+
+# Doesn't work if you have the Active Gem also installed
+
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+require 'lib/Active'
+puts "Using Active v#{Active::VERSION}"

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use 1.9.2@R2D2
+

data/Active.gemspec

@@ -1,36 +1,35 @@
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{Active}
-  s.version = "0.0.5"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jonathan Spooner, Brian Levine"]
-  s.date = %q{2010-09-02}
-  s.default_executable = %q{Active}
+  s.name        = "Active"
+  s.version     = Active::VERSION
+  s.date        = "2012-01-03"
+  s.authors     = ["Jonathan Spooner, Marc Leglise"]
+  s.email       = ["jspooner@gmail.com"]
+  s.homepage    = "http://developer.active.com/docs/Activecom_Search_API_Reference"
+  s.summary     = %q{Search api for Active Network}
   s.description = %q{Search api for Active Network}
-  s.email = %q{jspooner [at] gmail.com}
-  s.executables = ["Active"]
-  s.extra_rdoc_files = ["History.txt", "README.txt", "bin/Active", "version.txt"]
-  s.files = [".bnsignore", "Active.gemspec", "History.txt", "README.txt", "Rakefile", "bin/Active", "lib/Active.rb", "lib/services/activity.rb", "lib/services/search.rb", "spec/.DS_Store", "spec/Active_spec.rb", "spec/activity_spec.rb", "spec/search_spec.rb", "spec/spec_helper.rb", "test/test_Active.rb", "version.txt"]
-  s.homepage = %q{http://developer.active.com/docs/Activecom_Search_API_Reference}
-  s.rdoc_options = ["--main", "README.txt"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{Active}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Search api for Active Network}
-  s.test_files = ["test/test_Active.rb"]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.rubyforge_project = "Active"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bones>, [">= 3.4.7"])
-    else
-      s.add_dependency(%q<bones>, [">= 3.4.7"])
-    end
-  else
-    s.add_dependency(%q<bones>, [">= 3.4.7"])
-  end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.extra_rdoc_files = ["History.txt", "README.md"]
+  s.rdoc_options = ["--main", "README.md"]
+  
+  s.add_dependency "json", "~> 1"
+  s.add_dependency "hashie", "~> 1"
+  s.add_dependency "activesupport", "> 3"
+  s.add_dependency "htmlentities", "> 4"
+  # s.add_dependency "savon", "= 0.7.9"
+  # s.add_dependency "dalli", "= 0.9.8"
+  
+  s.add_development_dependency "rspec", "~> 2"
+  s.add_development_dependency "metric_fu", "~> 2"
+  # s.add_development_dependency "mocha", "= 0.9.8"
 end

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in Active.gemspec
+gemspec

data/History.txt

@@ -1,4 +1,7 @@
-== 1.0.0 / 2010-08-30
+== 0.1.1 / 2011-07-11
+* Fixed GSA number of results GSA bug to make pagination work as expected.
 
-* 1 major enhancement
+== 0.1.0 / 2010-08-30
+
+* Improving organization and api
   * Birthday!

data/{README.txt → README.md}

@@ -1,33 +1,17 @@
 Active
-    by Jonathan Spooner and Brian Levine
+    by Jonathan Spooner and Marc Leglise
     http://developer.active.com/docs/Activecom_Search_API_Reference
 
 == DESCRIPTION:
 
 Search api for Active Network
 
-== FEATURES/PROBLEMS:
+For use with Ruby 1.9
 
-* Seach API
+== Development
 
-== SYNOPSIS:
+To use in irb do `rake install` then `irb` and `require 'Active'`
 
-	Search.search( {:location => "San Diego, CA, US"} )
-
-	List all categories
-	Active::Services::Search.CHANNELS.each do |key, value| 
-		puts key.to_s.humanize
-	end 
-	
-	
-
-== REQUIREMENTS:
-
-* none
-
-== INSTALL:
-
-* sudo gem install Active
 
 == LICENSE:
 

data/Rakefile

@@ -1,24 +1,18 @@
+begin
+  require 'bundler/gem_tasks'
+rescue LoadError
+  abort '### Please install the "bundler" gem ###'
+end
 
 begin
-  require 'bones'
+  require 'metric_fu'
 rescue LoadError
-  abort '### Please install the "bones" gem ###'
 end
 
-task :default => 'test:run'
-task 'gem:release' => 'test:run'
 
-Bones {
-  name  'Active'
-  authors  'Jonathan Spooner, Brian Levine'
-  email    'jspooner [at] gmail.com'
-  url      'http://developer.active.com/docs/Activecom_Search_API_Reference'
-  gem.extras[:post_install_message] = <<-MSG
-  --------------------------
-  Welcome to Active Network
-  --------------------------
-  MSG
-  depend_on  'savon', '0.7.9'
-  depend_on  'dalli', '0.9.8'
-}
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  # t.pattern = 'spec/search_spec.rb'
+end
 
+task :default => :spec

data/lib/Active.rb

@@ -1,80 +1,12 @@
-module Active
-
-  
-  # attr_reader :CACHE
-  # attr_accessor :CACHE
-  
-  # :stopdoc:
-  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
-  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-  # :startdoc:
-
-  # Returns the version string for the library.
-  #
-  def self.version
-    @version ||= File.read(path('version.txt')).strip
-  end
-
-  # Returns the library path for the module. If any arguments are given,
-  # they will be joined to the end of the libray path using
-  # <tt>File.join</tt>.
-  #
-  def self.libpath( *args, &block )
-    rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
-    if block
-      begin
-        $LOAD_PATH.unshift LIBPATH
-        rv = block.call
-      ensure
-        $LOAD_PATH.shift
-      end
-    end
-    return rv
-  end
-
-  # Returns the lpath for the module. If any arguments are given,
-  # they will be joined to the end of the path using
-  # <tt>File.join</tt>.
-  #
-  def self.path( *args, &block )
-    rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
-    if block
-      begin
-        $LOAD_PATH.unshift PATH
-        rv = block.call
-      ensure
-        $LOAD_PATH.shift
-      end
-    end
-    return rv
-  end
+require 'active/version'
+require 'ext/hash_extensions.rb'
 
-  # Utility method used to require all files ending in .rb that lie in the
-  # directory below this file that has the same name as the filename passed
-  # in. Optionally, a specific _directory_ name can be passed in such that
-  # the _filename_ does not have to be equivalent to the directory.
-  #
-  def self.require_all_libs_relative_to( fname, dir = nil )
-    dir ||= ::File.basename(fname, '.*')
-    search_me = ::File.expand_path(
-        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
-
-    Dir.glob(search_me).sort.each {|rb| require rb}
-  end
-  
-  # Active.memcache_host = "localhost:11211"
-  def self.memcache_host(url)
-    require 'dalli'
-    @CACHE = Dalli::Client.new(url)
-  end
-    
-  def self.CACHE
-    @CACHE
-  end
-
-  
-end  # module Active
-
-Active.require_all_libs_relative_to(__FILE__)
-Active.require_all_libs_relative_to(__FILE__, 'services')
-require 'savon'
+module Active
+  # require files in order!
+  [
+    :errors, :query, :asset, :results,
+    :activity, :article, :result, :training
+  ].each do |constant|
+    require "active/#{constant.to_s}"
+  end
+end

data/lib/active/activity.rb

@@ -0,0 +1,7 @@
+module Active
+  class Activity < Asset
+    def self.facet
+      'activities'
+    end
+  end
+end

data/lib/active/article.rb

@@ -0,0 +1,7 @@
+module Active
+  class Article < Asset
+    def self.facet
+      'articles'
+    end
+  end
+end

data/lib/active/asset.rb

@@ -0,0 +1,205 @@
+require 'hashie'
+require 'json'
+require 'htmlentities'
+require 'active_support/multibyte/unicode'
+
+module Active
+  class Asset < Hashie::Mash
+    
+    # * No punctuation: Returns the value of the hash for that key, or nil if none exists.
+    # * Assignment (<tt>=</tt>): Sets the attribute of the given method name.
+    # * Existence (<tt>?</tt>): Returns true or false depending on whether that key has been set.
+    # * Bang (<tt>!</tt>): Forces the existence of this key, used for deep Mashes. Think of it as "touch" for mashes.
+    #
+    # == Basic Example
+    #
+    #   mash = Mash.new
+    #   mash.name? # => false
+    #   mash.name = "Bob"
+    #   mash.name # => "Bob"
+    #   mash.name? # => true
+    #
+    # == Hash Conversion  Example
+    #
+    #   hash = {:a => {:b => 23, :d => {:e => "abc"}}, :f => [{:g => 44, :h => 29}, 12]}
+    #   mash = Mash.new(hash)
+    #   mash.a.b # => 23
+    #   mash.a.d.e # => "abc"
+    #   mash.f.first.g # => 44
+    #   mash.f.last # => 12
+    #
+    # == Bang Example
+    #
+    #   mash = Mash.new
+    #   mash.author # => nil
+    #   mash.author! # => <Mash>
+    #
+    #   mash = Mash.new
+    #   mash.author!.name = "Michael Bleigh"
+    #   mash.author # => <Mash name="Michael Bleigh">
+    #
+    def title
+      return @title if @title
+      if self.title?
+        # Notice we have to use self['hash'] to get the original value so we don't stackoverflow
+        @title = ActiveSupport::Multibyte::Unicode.tidy_bytes(self['title'])
+        @title = @title.split("|")[0].strip if @title.include?("|")
+        @title = @title.gsub(/<\/?[^>]*>/, "")
+        @title = @title.gsub("...", "")
+        @title = ::HTMLEntities.new.decode( @title )
+      end
+      @title
+    end
+    
+    def description
+      return @description if @description
+      if self.meta!.summary?
+        # Notice we have to use self['hash'] to get the original value so we don't stackoverflow
+        @description = ActiveSupport::Multibyte::Unicode.tidy_bytes( self.meta.summary )
+        @description = @description.gsub(/<\/?[^>]*>/, "")
+        @description = ::HTMLEntities.new.decode( @description )
+      end
+      @description
+    end
+
+    def start_date
+      if self.meta!.startDate?
+        if self.meta!.startTime?
+          Time.parse("#{self.meta.startDate} #{self.meta.startTime}")
+        else
+          Date.parse(self.meta.startDate)
+        end
+      else
+        nil
+      end
+    end
+    
+    def asset_id
+      aid = self.meta!.assetId
+      if aid.kind_of?(Array)
+        aid = aid.first
+      end
+      aid.upcase
+    end
+    
+    def address
+      if self.meta['address']
+        return self.meta['address']
+      elsif self.meta['location']
+        return self.meta['location']
+      else
+        return "#{self.meta.city}, #{self.meta.state}"
+      end
+    end
+    
+    def zip
+      self.meta['zip'] # an inheritated object defines zip so we need to override it.
+    end
+        
+    class << self
+      def factory(data)
+        begin
+        category = data['meta']['category']
+        rescue NoMethodError
+          category = nil
+        end
+        
+        type = case category
+        when 'Activities'
+          Active::Activity
+        when 'Articles'
+          Active::Article
+        when 'Training plans'
+          Active::Training
+        else
+          Active::Asset
+        end
+        type.new(data)
+      end
+      
+      # this code smells
+      def find(asset_ids=nil)
+        raise Active::InvalidOption, "Couldn't find Asset without an ID" if asset_ids.nil?
+        query    = Active::Query.new
+        ids       = asset_ids.kind_of?(Array) ? asset_ids : [asset_ids]
+        query.options[:meta][:assetId] = ids.collect{ |id| id.gsub("-","%2d") }
+
+        # Executes the actual search API call
+        res = query.search
+
+        # Ensure we have found all of the IDs requested, otherwise raise an error
+        # that includes which ID(s) are missing.
+        if res['numberOfResults'] != ids.length
+          missing_ids = Array.new(ids)
+          res['_results'].each do |r|
+            found_id = r['meta']['assetId'] & missing_ids
+            missing_ids -= found_id
+          end
+          raise Active::RecordNotFound, "Couldn't find record with asset_id: #{missing_ids.join(',')}"
+        end
+
+        a = []
+        res['_results'].collect do |d|
+          t      = self.new(d)
+          a << t
+        end
+
+        if a.length == 1
+          return a.first
+        else
+          return a
+        end
+      end
+
+      # Active::Activity.find_by_url("http://www.active.com#{request.fullpath}")
+      # url = http://search.active.com/search?v=list&m=site:www.active.com/running/san-diego-ca/americas-finest-city-half-marathon-and-5k-2011
+      def find_by_url(url)
+        raise Active::InvalidOption, "Couldn't find Asset without a url" if url.nil?
+        query                = Active::Query.new
+        query.options[:m] << "site:#{url}"
+        
+        # Executes the actual search API call
+        res = query.search
+        if res['numberOfResults'].to_i < 1
+          raise Active::RecordNotFound, "Couldn't find record with asset_id: #{url}"
+        end
+
+        a = []
+        res['_results'].collect do |d|
+          t      = self.new(d)
+          a << t
+        end
+
+        if a.length == 1
+          return a.first
+        else
+          return a
+        end
+      end
+
+      # Example
+      # Asset.zip("92121")
+      [
+        :sort, :order, :limit, :per_page, :page,
+        :category, :keywords, :channel, :splitMediaType,
+        :location, :state, :city, :zip, :zips, :bounding_box, :dma, :near, 
+        :date_range, :future, :past, :today, :radius
+      ].each do |method_name|
+        define_method(method_name) do |*val|
+          Active::Query.new(:facet => self.facet).send(method_name, *val)
+        end
+      end
+      
+      # We have several different types of data in the Search index.  To restrict a search to a particular type, use the facet parameter.  The available values are:
+      #     activities - things like running events or camps
+      #     results - race results from results.active.com
+      #     training - training plans
+      #     articles - articles on active.com and ihoops.com
+      # This method should be overridden in child classes to return the appropriate type string.
+      def facet
+        ''
+      end
+    end
+    
+  end
+end