arkayne_rails 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,174 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.

data/NOTICE

@@ -0,0 +1,3 @@
+arkayne_rails
+
+Copyright 2010, Marc Chung. All rights reserved.

data/README.rdoc

@@ -0,0 +1,27 @@
+= Arkayne API Helper Plugin Generator
+
+== Description
+
+Copies the necessary files into your Rails project.
+
+Currently only supports rails-2
+
+== Usage
+./script/server generate arkayne_rails
+
+== Example
+./script/server generate arkayne_rails
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Marc Chung. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "arkayne_rails"
+    gem.summary = %Q{Arkayne Ruby on Rails plugin}
+    gem.description = %Q{Get recommendations from Arkayne. Sign up at http://arkayne.com/login}
+    gem.email = "mchung@gmail.com"
+    gem.homepage = "http://github.com/mchung/arkayne_rails"
+    gem.authors = ["Marc Chung"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "arkayne_rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/arkayne_rails.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{arkayne_rails}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marc Chung"]
+  s.date = %q{2010-08-29}
+  s.description = %q{Get recommendations from Arkayne. Sign up at http://arkayne.com/login}
+  s.email = %q{mchung@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "NOTICE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "arkayne_rails.gemspec",
+     "generators/arkayne_rails/README",
+     "generators/arkayne_rails/USAGE",
+     "generators/arkayne_rails/arkayne_rails_generator.rb",
+     "generators/arkayne_rails/install.rb",
+     "generators/arkayne_rails/templates/config/arkayne.yml",
+     "generators/arkayne_rails/templates/config/initializers/arkayne_init.rb",
+     "generators/arkayne_rails/templates/lib/arkayne_api_helper.rb",
+     "generators/arkayne_rails/templates/lib/tasks/arkayne.rake",
+     "lib/arkayne_rails.rb",
+     "test/helper.rb",
+     "test/test_arkayne_rails.rb"
+  ]
+  s.homepage = %q{http://github.com/mchung/arkayne_rails}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Arkayne Ruby on Rails plugin}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_arkayne_rails.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/generators/arkayne_rails/README

@@ -0,0 +1 @@
+Blah

data/generators/arkayne_rails/USAGE

@@ -0,0 +1,2 @@
+Usage:
+  ./script/generate arkayne_rails

data/generators/arkayne_rails/arkayne_rails_generator.rb

@@ -0,0 +1,18 @@
+class ArkayneRailsGenerator < Rails::Generator::Base
+
+  def banner
+    "Usage: ./script/generate arkayne_rails"
+  end
+
+  def manifest
+    record do |m|
+      m.directory "config/initializers"
+      m.directory "lib/tasks"
+      m.file "config/arkayne.yml", "config/arkayne.yml"
+      m.file "config/initializers/arkayne_init.rb", "config/initializers/arkayne_init.rb"
+      m.file "lib/arkayne_api_helper.rb", "lib/arkayne_api_helper.rb"
+      m.file "lib/tasks/arkayne.rake", "lib/tasks/arkayne.rake"
+    end
+  end
+
+end

data/generators/arkayne_rails/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/generators/arkayne_rails/templates/config/arkayne.yml

@@ -0,0 +1,11 @@
+common: &common
+  arkayne_profile_token: <%= ENV['ARKAYNE_PROFILE_TOKEN'] %>
+
+development:
+  <<: *common
+
+test:
+  <<: *common
+
+production:
+  <<: *common

data/generators/arkayne_rails/templates/config/initializers/arkayne_init.rb

@@ -0,0 +1 @@
+ActionView::Base.send :include, ArkayneApiHelper

data/generators/arkayne_rails/templates/lib/arkayne_api_helper.rb

@@ -0,0 +1,46 @@
+# Arkayne API helper module
+#
+# For example:
+#
+#   ark_recommendations_for("Pksk-7285-sekr3t-k3y", "http://example.com/2010/02/29/arkayne-api-is-best")
+#   # => <a String containing recommendations, in HTML>
+#
+module ArkayneApiHelper
+
+  SITE_URL = "http://www.arkayne.com/plugin"
+  SECURE_SITE_URL = "https://www.arkayne.com/plugin/secure"
+
+  # Issues a call to the Arkayne API
+  # 
+  # arkayne_profile_token - Provided by Arkayne.com.
+  # full_url - Fully qualified URL, i.e. http://example.com/2010/02/29/arkayne-api-is-best
+  #
+  # Returns an HTML String
+  def arkayne_recommendations_for(full_url, arkayne_profile_token = default_arkayne_profile_token)
+    url_to_fetch = "#{SITE_URL}/#{arkayne_profile_token}/rails/?url=#{full_url}"
+    Net::HTTP.get URI.parse(url_to_fetch)
+  end
+  
+  # Read Arkayne Profile Token
+  #
+  # Returns a String
+  def default_arkayne_profile_token
+    ark_load_config(RAILS_ENV)["arkayne_profile_token"]
+  end
+  
+  # Reads config/arkayne.yml and returns the arkayne_profile_token
+  #
+  # rails_env - Current Rails ENV variable, i.e. RAILS_ENV
+  #
+  # Returns a Hash containing the current profile configuration
+  def ark_load_config(rails_env = RAILS_ENV)
+    if @ark_profile_token.nil?
+      file = Rails.root.join('config', 'arkayne.yml').to_s
+      erbc = ERB.new(File.read(file)).result
+      yaml = YAML.load(erbc)
+      @ark_profile_token = yaml[rails_env]
+    end
+    @ark_profile_token
+  end
+
+end

data/generators/arkayne_rails/templates/lib/tasks/arkayne.rake

@@ -0,0 +1,20 @@
+# Arkayne Rake Helper
+#
+# For interactive debugging and testing purposes
+namespace :arkayne do
+  include ArkayneApiHelper
+
+  def arkayne_profile_token
+    apt = ark_load_config(RAILS_ENV)["arkayne_profile_token"]
+    raise "Couldn't find ENV['ARKAYNE_PROFILE_TOKEN']" unless apt
+    apt
+  end
+
+  # Usage
+  #   ARKAYNE_PROFILE_TOKEN=2010-THizMyKey URL=http://foo.com/blah.html rake arkayne:recos_for_url
+  desc "Prints Arkayne recommendations for ENV['URL'] to STDOUT"
+  task :recos_for_url => :environment do
+    puts arkayne_recommendations_for(ENV['URL'], arkayne_profile_token)
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'arkayne_rails'
+
+class Test::Unit::TestCase
+end

data/test/test_arkayne_rails.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestArkayneRails < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: arkayne_rails
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Marc Chung
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Get recommendations from Arkayne. Sign up at http://arkayne.com/login
+email: mchung@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- NOTICE
+- README.rdoc
+- Rakefile
+- VERSION
+- arkayne_rails.gemspec
+- generators/arkayne_rails/README
+- generators/arkayne_rails/USAGE
+- generators/arkayne_rails/arkayne_rails_generator.rb
+- generators/arkayne_rails/install.rb
+- generators/arkayne_rails/templates/config/arkayne.yml
+- generators/arkayne_rails/templates/config/initializers/arkayne_init.rb
+- generators/arkayne_rails/templates/lib/arkayne_api_helper.rb
+- generators/arkayne_rails/templates/lib/tasks/arkayne.rake
+- lib/arkayne_rails.rb
+- test/helper.rb
+- test/test_arkayne_rails.rb
+has_rdoc: true
+homepage: http://github.com/mchung/arkayne_rails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Arkayne Ruby on Rails plugin
+test_files: 
+- test/helper.rb
+- test/test_arkayne_rails.rb