recaptcha-mailhide 0.1.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c98860c5c0ad248c68ae498d7d4d23b0fa65fc4
+  data.tar.gz: 096afdf3b50cef502af4dc9d33a168ce1bde4118
+SHA512:
+  metadata.gz: 696b149f31ca6022ceabe2c2f63316e5bba031be02a075b4bc9d844507695178f04e530e559d734bfa46c3653f969490f0e57149dc2ab03a9f6ca674306d7f6b
+  data.tar.gz: 56944e0c7996ec8cafa0c83eafd62b97fea0643d254a86ff037bae88d01c6d42eb07f3ae52893132a242f6bba2f2c41e89ff98c1ec6ac121e92005f1473b773c

data/.gitignore

@@ -0,0 +1,38 @@
+Gemfile.lock
+
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For vim:
+*.swp
+
+# For redcar:
+.redcar
+
+# For rubinius:
+*.rbc

data/CHANGELOG.rdoc

@@ -0,0 +1,10 @@
+== 1.0.0
+
+* Added Rails view helpers
+* Made generated URLs use HTTPS
+* Removed Jeweler dependency
+* General cleanup
+
+== 0.1.1
+
+* First release

data/Gemfile

@@ -1,7 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
-group :development do
-  gem "rspec", "~> 2.9.0"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 1.8.3"
-end
+gemspec

data/README.rdoc

@@ -1,34 +1,68 @@
 = ReCAPTCHA Mailhide
 
-This gem provides support for ReCAPTCHA's Mailhide API.
-
-At the moment it only generates URLs, it doesn't provide any link helpers, so it's completely framework agnostic (and a bit on the lower side of features).
+This gem provides Ruby (and Rails) support for ReCAPTCHA's Mailhide API.
 
 == Installation
 
-Simply run:
-
-    gem install recaptcha-mailhide
+Add this to your Gemfile:
 
-Or if you're using bundler:
-
-    gem 'recaptcha-mailhide'
+  gem 'recaptcha-mailhide'
 
 == Configuration
 
-Easy:
+Add this somewhere (if you're using Rails put it in
+config/initializers/recaptcha_mailhide.rb):
+
+  RecaptchaMailhide.configure do |c|
+    c.private_key = '...'
+    c.public_key  = '...'
+  end
 
-    RecaptchaMailhide.configure do |c|
-      c.private_key = 'your private key here'
-      c.public_key  = 'your public key here'
-    end
+If you need a set of public/private keys get them from
+https://www.google.com/recaptcha/mailhide/apikey
 
 == Usage
 
-Call <tt>RecaptchaMailhide::URL.url_for(email)</tt> to get the ReCAPTCHA Mailhide URL.
+=== In Rails views
+
+  recaptcha_mailhide('foo@example.com')
+
+You can also provide content as a method argument or a block (just like with
+<code>link_to</code>):
+
+  # Content in argument
+  recaptcha_mailhide('Click to view email', 'foo@example.com')
+  
+  recaptcha_mailhide('foo@example.com') do
+    # Content here
+  end
+
+You can also provide options (they get forwarded to <code>link_to</code>):
+
+    recaptcha_mailhide('foo@example.com', class: 'hidden-email', target: '_blank')
+
+In addition it accepts a <code>:popup</code> option that will make the link
+open in a popup window (requires JavaScript):
+
+  recaptcha_mailhide('foo@example.com', popup: true)
+  
+  # Configuring popup window size
+  recaptcha_mailhide('foo@example.com', popup: { width: 600, height: 600 })
+
+=== Pure Ruby
+
+Use the following to get just the ReCAPTCHA Mailhide URL (without a link tag):
+
+  RecaptchaMailhide.url_for(email)
+
+== TODO
+
+* Tests for Rails helpers
+* Basic helpers (non-dependent on Rails)
+* Rails generator for initializer with auto-fetching of private/public keys
 
-At the moment this gem doesn't provide any helpers to build HTML link tags.
+== Copyright
 
-== License
+This gem is Copyright (c) 2012 Pedro Fayolle. See LICENSE.txt for further details.
 
-MIT License. Copyright (c) 2012 Pedro Fayolle.
+ReCAPTCHA Mailhide is Copyright (c) Google, Inc. This is gem is NOT affiliated with Google, Inc.

data/Rakefile

@@ -1,50 +1,18 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
 begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "recaptcha-mailhide"
-  gem.homepage = "http://github.com/pilaf/recaptcha-mailhide"
-  gem.license = "MIT"
-  gem.summary = %Q{ReCAPTCHA Mailhide for Ruby}
-  gem.description = %Q{Ruby implementation of ReCAPTCHA Mailhide's API}
-  gem.email = "pfayolle@gmail.com"
-  gem.authors = ["Pedro Fayolle"]
-  gem.files.include Dir["lib/**/*.rb"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
 require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
+RDoc::Task.new(:rdoc) do |rdoc|
+  require 'recaptcha_mailhide/version'
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "recaptcha-mailhide #{version}"
-  rdoc.rdoc_files.include('README*')
+  rdoc.title    = "recaptcha-mailhide #{RecaptchaMailhide::VERSION}"
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+Bundler::GemHelper.install_tasks

data/lib/recaptcha_mailhide.rb

@@ -2,6 +2,8 @@ require 'recaptcha_mailhide/configuration'
 require 'recaptcha_mailhide/encrypt'
 require 'recaptcha_mailhide/url'
 
+require 'recaptcha_mailhide/railtie' if defined?(Rails)
+
 module RecaptchaMailhide
   def self.configuration
     @configuration ||= Configuration.new
@@ -10,4 +12,8 @@ module RecaptchaMailhide
   def self.configure
     yield configuration
   end
+
+  def self.url_for(email_address)
+    URL.url_for(email_address)
+  end
 end

data/lib/recaptcha_mailhide/configuration.rb

@@ -1,5 +1,15 @@
 module RecaptchaMailhide
   class Configuration
-    attr_accessor :private_key, :public_key
+    attr_writer :private_key, :public_key
+
+    def private_key
+      raise "RecaptchaMailhide's private_key is not set. If you're using Rails add an initializer to config/initializers." unless @private_key
+      @private_key
+    end
+
+    def public_key
+      raise "RecaptchaMailhide's public_key is not set. If you're using Rails add an initializer to config/initializers." unless @public_key
+      @public_key
+    end
   end
 end

data/lib/recaptcha_mailhide/encrypt.rb

@@ -14,7 +14,7 @@ module RecaptchaMailhide
       urlsafe_base64(aes.update(pad_string(string)) + aes.final)
     end
 
-  private
+    private
 
     # Converts the given string to Base64 encoding,
     # replacing '+' with '-', '/' with '_' and

data/lib/recaptcha_mailhide/helpers/action_view_helper.rb

@@ -0,0 +1,96 @@
+module RecaptchaMailhide
+  module ActionViewHelper
+    # Generates a link tag to a ReCAPTCHA Mailhide URL for the given email
+    # address.
+    #
+    # If a block is given it will use it to generate the content, and takes
+    # these attributes:
+    #
+    # * +email+ - The email address to hide
+    # * +options+ - See options below
+    #
+    # When no block is given it accepts two forms:
+    #
+    #   # Just email
+    #   recaptcha_mailhide(email, options = {})
+    #
+    #   # Email and content
+    #   recaptcha_mailhide(content, email, options = {})
+    #
+    # In the first instance it will process the email with
+    # <code>truncate_email</code> and use it as the link content.
+    #
+    # ==== Options
+    #
+    # Accepts every option supported by <code>link_to</code>, plus:
+    #
+    # [:popup]
+    #
+    #   Set it to <code>true</code> to have the link open a popup window
+    #   (through JavaScript and the <code>onclick</code> event).
+    #
+    #   Can also be a hash of sub-options, which can be <code>:width</code> and
+    #   <code>:height</code>, setting the size of the popup window.
+    #
+    # In case of not supplying your own content you can also pass options for
+    # <code>truncate_email</code>, e.g.:
+    #
+    #   recaptcha_mailhide('foo@example.com', omission: '-', truncate_domain: true)
+    #
+    def recaptcha_mailhide(*args, &block)
+      options = args.extract_options!
+      raise ArgumentError, "at least one argument is required (not counting options)" if args.empty?
+
+      if block_given?
+        url = RecaptchaMailhide.url_for(args.first)
+        link_to(url, recaptcha_mailhide_options(url, options), &block)
+      else
+        if args.length == 1
+          content = truncate_email(args.first, options)
+          url = RecaptchaMailhide.url_for(args.first)
+        else
+          content = args.first
+          url = RecaptchaMailhide.url_for(args.second)
+        end
+        link_to(content, url, recaptcha_mailhide_options(url, options))
+      end
+    end
+
+    # Truncates an email address, e.g.:
+    #
+    #   truncate_email('example@example.com') # => e…@example.com
+    #   truncate_email('example@example.com', truncate_domain: true) # => e…@e…
+    #
+    # ==== Options
+    #
+    # [:omission]
+    #
+    #   The string to use in replacement of the removed characters.
+    #
+    # [:truncate_domain]
+    #
+    #   Boolean. Whether to truncate the domain part of the address as well.
+    #
+    def truncate_email(email, options = {})
+      return "" unless email.match(/@/)
+      split_email = email.split('@')
+      omission = options[:omission] || "…"
+      local_part = "#{split_email.first.first}#{omission}"
+      domain = options[:truncate_domain] ? "#{split_email.last.first}#{omission}" : split_email.last
+      "#{local_part}@#{domain}"
+    end
+
+    private
+
+    def recaptcha_mailhide_options(url, options)
+      options.dup.tap do |o|
+        if o[:popup]
+          popup = o.delete(:popup)
+          popup = popup.is_a?(Hash) ? popup.dup : {}
+          popup.reverse_merge!(width: 500, height: 300)
+          o[:onclick] = "window.open('#{url}', '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=#{popup[:width]},height=#{popup[:height]}'); return false;"
+        end
+      end
+    end
+  end
+end

data/lib/recaptcha_mailhide/railtie.rb

@@ -0,0 +1,9 @@
+require 'recaptcha_mailhide/helpers/action_view_helper'
+
+module RecaptchaMailhide
+  class Railtie < ::Rails::Railtie # :nodoc:
+    initializer 'recaptcha-mailhide' do
+      ::ActionView::Base.send :include, RecaptchaMailhide::ActionViewHelper
+    end
+  end
+end

data/lib/recaptcha_mailhide/url.rb

@@ -1,11 +1,11 @@
 module RecaptchaMailhide
   module URL
-    BASE_URL = "http://www.google.com/recaptcha/mailhide/d"
+    BASE_URL = "https://www.google.com/recaptcha/mailhide/d"
 
-    def self.url_for(email)
+    def self.url_for(email_address)
       public_key = RecaptchaMailhide.configuration.public_key
-      encrypted_email = RecaptchaMailhide::Encrypt.encrypt(email)
-      BASE_URL + "?k=#{public_key}&c=#{encrypted_email}"
+      encrypted_address = Encrypt.encrypt(email_address)
+      BASE_URL + "?k=#{public_key}&c=#{encrypted_address}"
     end
   end
 end

data/lib/recaptcha_mailhide/version.rb

@@ -0,0 +1,3 @@
+module RecaptchaMailhide
+  VERSION = '1.0.0'
+end

data/recaptcha-mailhide.gemspec

@@ -1,62 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = "recaptcha-mailhide"
-  s.version = "0.1.1"
+# Maintain your gem's version:
+require "recaptcha_mailhide/version"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Pedro Fayolle"]
-  s.date = "2012-04-18"
-  s.description = "Ruby implementation of ReCAPTCHA Mailhide's API"
-  s.email = "pfayolle@gmail.com"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/recaptcha-mailhide.rb",
-    "lib/recaptcha_mailhide.rb",
-    "lib/recaptcha_mailhide/configuration.rb",
-    "lib/recaptcha_mailhide/encrypt.rb",
-    "lib/recaptcha_mailhide/url.rb",
-    "recaptcha-mailhide.gemspec",
-    "spec/recaptcha_mailhide/encrypt_spec.rb",
-    "spec/recaptcha_mailhide/url_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/pilaf/recaptcha-mailhide"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "ReCAPTCHA Mailhide for Ruby"
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "recaptcha-mailhide"
+  s.version     = RecaptchaMailhide::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pedro Fayolle"]
+  s.email       = ["pfayolle@gmail.com"]
+  s.homepage    = "http://github.com/pilaf/recaptcha-mailhide"
+  s.summary     = "ReCAPTCHA Mailhide client"
+  s.description = "Implementation of Google's ReCAPTCHA Mailhide API"
+  s.license     = "MIT"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ['README.rdoc']
+  s.require_paths = ['lib']
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.9.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-    else
-      s.add_dependency(%q<rspec>, ["~> 2.9.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    end
-  else
-    s.add_dependency(%q<rspec>, ["~> 2.9.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-  end
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'rspec', ['>= 0']
 end
-

data/spec/recaptcha_mailhide/url_spec.rb

@@ -7,7 +7,7 @@ describe RecaptchaMailhide::URL do
 
   describe ".url_for" do
     it("returns the proper URL") do
-      RecaptchaMailhide::URL.url_for('foo@bar.com').should eq('http://www.google.com/recaptcha/mailhide/d?k=PUBLIC_KEY&c=ABC')
+      RecaptchaMailhide::URL.url_for('foo@bar.com').should eq('https://www.google.com/recaptcha/mailhide/d?k=PUBLIC_KEY&c=ABC')
     end
   end
 end

metadata

@@ -1,61 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: recaptcha-mailhide
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Pedro Fayolle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &15326280 !ruby/object:Gem::Requirement
-    none: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *15326280
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &15325280 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: *15325280
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &15323760 !ruby/object:Gem::Requirement
-    none: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15323760
-description: Ruby implementation of ReCAPTCHA Mailhide's API
-email: pfayolle@gmail.com
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implementation of Google's ReCAPTCHA Mailhide API
+email:
+- pfayolle@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE.txt
 - README.rdoc
 files:
-- .document
-- .rspec
+- ".document"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.rdoc
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
@@ -64,7 +59,10 @@ files:
 - lib/recaptcha_mailhide.rb
 - lib/recaptcha_mailhide/configuration.rb
 - lib/recaptcha_mailhide/encrypt.rb
+- lib/recaptcha_mailhide/helpers/action_view_helper.rb
+- lib/recaptcha_mailhide/railtie.rb
 - lib/recaptcha_mailhide/url.rb
+- lib/recaptcha_mailhide/version.rb
 - recaptcha-mailhide.gemspec
 - spec/recaptcha_mailhide/encrypt_spec.rb
 - spec/recaptcha_mailhide/url_spec.rb
@@ -72,29 +70,28 @@ files:
 homepage: http://github.com/pilaf/recaptcha-mailhide
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1066762596205955725
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
-summary: ReCAPTCHA Mailhide for Ruby
-test_files: []
+specification_version: 4
+summary: ReCAPTCHA Mailhide client
+test_files:
+- spec/recaptcha_mailhide/encrypt_spec.rb
+- spec/recaptcha_mailhide/url_spec.rb
+- spec/spec_helper.rb

data/Gemfile.lock

@@ -1,30 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.3)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.6.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  jeweler (~> 1.8.3)
-  rspec (~> 2.9.0)