screenshots 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35ad4fbb29c8d0e688fe89de3b8dd8e800dc86b6
+  data.tar.gz: ba5c15fdd9e24b591bb2a59782def6fed7f6ba38
+SHA512:
+  metadata.gz: 839343f6244c729307a99ac1afd1c95d2f1764ec21683248cf188aca8432292f612621ba5187312f959253b4629ed3f5da7b1512f0887873a38b8be01c94facf
+  data.tar.gz: 63d007e8db52d1925a3ae6b8740a8902184018b71a931d3355da50579c8dfc0788c654536882d82ddf2155f30113c14bc37732e5083fb91634e2fcd4f5815c5f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+screenshots

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jean-Baptiste Goulain
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Screenshots
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'screenshots'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install screenshots
+
+## Configuration
+
+```ruby
+# config/initializers/screenshots.rb
+Screenshots.configure do |config|
+  config.blog_assets_url = 'http://www.codeur.com/blog/wp-content/uploads/2014/07'
+  config.image_extension = 'jpg'
+end
+```
+
+## Usage
+
+### Generate HTML for a single URL
+
+```ruby
+Screenshots::Processor.generate('http://www.google.com')
+```
+
+It returns a string containing the HTML code to be copied in the blog post:
+```html
+<h2><a href="http://www.google.com">Google</a></h2>
+<img src="http://www.codeur.com/blog/wp-content/uploads/2014/07/http_www.google.com.jpg" />
+```
+
+### Generate HTML for a list of URLs
+
+```ruby
+Screenshots::Processor.generate_list(['http://www.google.com', 'http://www.lemonde.fr'])
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/screenshots/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/screenshots

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'screenshots'
+
+input_file_path = ARGV[0] || ''
+unless File.file?(input_file_path)
+  puts "The input file is invalid."
+  puts "screenshots my-input-file.txt"
+  puts "screenshots my-input-file.txt my/output/folder"
+  exit -1
+end
+
+output_path = ARGV[1] || Dir.pwd
+unless File.directory?(output_path)
+  puts "The output folder is invalid."
+  puts "screenshots my-input-file.txt"
+  puts "screenshots my-input-file.txt my/output/folder"
+  exit -1
+end
+
+# Load input file
+urls = []
+File.open(input_file_path, 'r') do |file|
+  file.each_line do |line|
+    urls << line.chomp if line.start_with?('http')
+  end
+end
+
+if urls.empty?
+  puts "No URL found."
+  exit -1
+end
+
+# Generate the HTML
+html = Screenshots::Processor.generate_list(urls)
+
+# Print output on disk
+output_file = File.join(output_path, 'html_for_blog.txt')
+if File.file?(output_file)
+  File.delete(output_file)
+end
+
+File.open(output_file, 'w') do |file|
+  file.write(html)
+end

data/lib/screenshots/configuration.rb

@@ -0,0 +1,22 @@
+module Screenshots
+  class Configuration
+    attr_accessor :blog_assets_url, :image_extension
+
+    def initialize
+      self.blog_assets_url = ''
+      self.image_extension = 'jpg'
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/lib/screenshots/page.rb

@@ -0,0 +1,35 @@
+require 'mechanize'
+
+module Screenshots
+  class Page
+    attr_reader :url, :title, :screenshot_name, :screenshot_url
+
+    def initialize(url)
+      @url = url
+      @screenshot_name = generate_screenshot_name(@url)
+      @blog_assets_url = Screenshots.configuration.blog_assets_url
+      @screenshot_extension = Screenshots.configuration.image_extension
+
+      agent = Mechanize.new
+      agent.get(@url) do |page|
+        @title = page.title
+      end
+    end
+
+    def generate_blog_section
+      section = "<h2><a href=\"#{@url}\">#{@title}</a></h2>\n"
+      section += "<img src=\"#{screenshot_url}\" />\n"
+    end
+
+    def screenshot_url
+      @screenshot_url ||= File.join(@blog_assets_url, @screenshot_name + "." + @screenshot_extension)
+    end
+
+    private
+
+    def generate_screenshot_name(url)
+      url.gsub(/(\:\/)*\//, '_')
+         .gsub(/[\?=\+\\&]/, '_')
+    end
+  end
+end

data/lib/screenshots/processor.rb

@@ -0,0 +1,18 @@
+module Screenshots
+  module Processor
+
+    def self.generate(url)
+      page = Screenshots::Page.new(url)
+      page.generate_blog_section
+    end
+
+    def self.generate_list(urls)
+      html = ""
+      urls.each do |url|
+        html += generate(url)
+        html += "\n"
+      end
+      html
+    end
+  end
+end

data/lib/screenshots/version.rb

@@ -0,0 +1,3 @@
+module Screenshots
+  VERSION = "0.0.1"
+end

data/lib/screenshots.rb

@@ -0,0 +1,4 @@
+require "screenshots/version"
+require "screenshots/configuration"
+require "screenshots/page"
+require "screenshots/processor"

data/screenshots.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'screenshots/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "screenshots"
+  spec.version       = Screenshots::VERSION
+  spec.authors       = ["Jean-Baptiste Goulain"]
+  spec.email         = ["jibai31@gmail.com"]
+  spec.summary       = %q{Get information on websites to be published in a blog}
+  spec.description   = %q{Takes a list of URLs, and generates a blog-friendly code that presents each of the websites}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "mechanize", '~> 2.7'
+end

data/spec/screenshots/configuration_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Screenshots::Configuration do
+
+  it "has a root_url" do
+    expect(Screenshots.configuration.blog_assets_url).to eq('http://blog')
+  end
+
+  it "has an image_extension" do
+    expect(Screenshots.configuration.image_extension).to eq('jpg')
+  end
+end

data/spec/screenshots/page_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Screenshots::Page do
+  before(:all) do
+    @url = 'https://github.com/rails/rails?param=1&x=2'
+    @page = Screenshots::Page.new(@url)
+  end
+
+  describe "#url" do
+    it "returns the URL" do
+      expect(@page.url).to eq(@url)
+    end
+  end
+
+  describe "#title" do
+    it "returns the page meta title" do
+      expect(@page.title).to eq('rails/rails · GitHub')
+    end
+  end
+
+  describe "#screenshot_name" do
+    it "is generated from the url" do
+      expect(@page.screenshot_name).to eq('https_github.com_rails_rails_param_1_x_2')
+    end
+  end
+
+  describe "#screenshot_url" do
+    it "returns the full url of the screenshot on the blog" do
+      expect(@page.screenshot_url).to eq('http://blog/https_github.com_rails_rails_param_1_x_2.jpg')
+    end
+  end
+
+  describe "#generate_blog_section" do
+    it "generates HTML code with a title and a picture" do
+
+      output = TestData.github_html_section
+      expect(@page.generate_blog_section).to eq(output)
+    end
+  end
+end

data/spec/screenshots/processor_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Screenshots::Processor do
+
+  describe ".generate" do
+    it "generates an HTML section for one site" do
+      url = 'http://www.google.com'
+      html = Screenshots::Processor.generate(url)
+      expect(html).to eq(TestData.google_html_section)
+    end
+  end
+
+  describe ".generate_list" do
+    it "generates HTML sections for a list of sites" do
+      urls = [
+        'http://www.google.com',
+        'https://github.com/rails/rails?param=1&x=2'
+      ]
+
+      expected_output = TestData.google_html_section + "\n" + TestData.github_html_section + "\n"
+
+      html = Screenshots::Processor.generate_list(urls)
+      expect(html).to eq(expected_output)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+
+require 'screenshots'
+require 'test_data'
+
+include TestData
+
+Screenshots.configure do |config|
+  config.blog_assets_url = 'http://blog'
+end

data/spec/test_data.rb

@@ -0,0 +1,14 @@
+module TestData
+
+  def github_html_section
+    %Q(<h2><a href="https://github.com/rails/rails?param=1&x=2">rails/rails · GitHub</a></h2>
+<img src="http://blog/https_github.com_rails_rails_param_1_x_2.jpg" />
+)
+  end
+
+  def google_html_section
+    %Q(<h2><a href="http://www.google.com">Google</a></h2>
+<img src="http://blog/http_www.google.com.jpg" />
+)
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: screenshots
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jean-Baptiste Goulain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Takes a list of URLs, and generates a blog-friendly code that presents
+  each of the websites
+email:
+- jibai31@gmail.com
+executables:
+- screenshots
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/screenshots
+- lib/screenshots.rb
+- lib/screenshots/configuration.rb
+- lib/screenshots/page.rb
+- lib/screenshots/processor.rb
+- lib/screenshots/version.rb
+- screenshots.gemspec
+- spec/screenshots/configuration_spec.rb
+- spec/screenshots/page_spec.rb
+- spec/screenshots/processor_spec.rb
+- spec/spec_helper.rb
+- spec/test_data.rb
+homepage: ''
+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.1
+signing_key: 
+specification_version: 4
+summary: Get information on websites to be published in a blog
+test_files:
+- spec/screenshots/configuration_spec.rb
+- spec/screenshots/page_spec.rb
+- spec/screenshots/processor_spec.rb
+- spec/spec_helper.rb
+- spec/test_data.rb