middleman-twitter-oembed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf104be4b9895b313d987752c3c99fa96f00b974
+  data.tar.gz: 905e1d36b4a0a35e04d4c6bf206f6a8c229069f0
+SHA512:
+  metadata.gz: ef6f428322f4c236b1fdf621e6f8a663db2aeb3b0964a79246fa16b0f6f5fc65149743f16deb98d05682ceca8624d56eb1d4dcfdac26dc3b5827e321fb4843d4
+  data.tar.gz: 568a4a6d0ce31252fa92088f2aa6e554c2020b055965feaad2efd3af2fbdfc6edddedac15b183405133c150ec81ed0d9d634f4ff7276bf05c29063ce34ab1d0d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*~

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.2
+
+script: "bundle exec rake test"
+
+env: TEST=true

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## master
+
+### 0.1.0
+
+* released 2015-4-25
+* initial version

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-twitter-oembed.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/README.md

@@ -0,0 +1,78 @@
+[![Gem Version](https://badge.fury.io/rb/middleman-twitter-oembed.svg)](http://badge.fury.io/rb/middleman-twitter-oembed)
+[![Build Status](https://travis-ci.org/atarukodaka/middleman-twitter-oembed.svg)](https://travis-ci.org/atarukodaka/middleman-twitter-oembed)
+[![Coverage Status](https://coveralls.io/repos/atarukodaka/middleman-twitter-oembed/badge.svg)](https://coveralls.io/r/atarukodaka/middleman-twitter-oembed)
+[![Code Climate](https://codeclimate.com/github/atarukodaka/middleman-twitter-oembed/badges/gpa.svg)](https://codeclimate.com/github/atarukodaka/middleman-twitter-oembed)
+
+
+## Middleman::TwitterOembed
+
+An extension to render and/or convert twitter stauts id into e-Embed status.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'middleman-twitter-oembed'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-twitter-oembed
+
+## Usage
+
+in config.rb:
+
+    activate :twitter_oembed
+
+### convert before rendering
+
+on default, twitter url(like 'http://twitter.com/foo/123456789') will be converted to twitter box before rendering.
+
+You can change the regex to match:
+
+```ruby
+activate :twitter_oembed do |twitter|
+  twitter.convert_regex = %r{\[\[twitter: *(\d+)\]\]}
+end
+```
+
+If you don't want to convert, set false for enable_convert option:
+
+```ruby
+activate :twitter_oembed do |twitter|
+  twitter.enable_convert = false
+end
+```
+
+### helper
+
+in *.erb:
+
+```
+<%= twitter_oembed('123456789') %>
+
+or
+
+<%= twitter_oembed_by_url('http://twitter.com/foo/status/123456789') %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/atarukodaka/middleman-twitter-oembed/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,21 @@
+require "bundler/gem_tasks"
+require 'rake/clean'
+
+require 'cucumber/rake/task'
+require 'middleman-core'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  ENV["TEST"] = "true"
+
+  exempt_tags = ""
+  exempt_tags << "--tags ~@nojava " if RUBY_PLATFORM == "java"
+  exempt_tags << "--tags ~@three_one " unless ::Middleman::VERSION.match(/^3\.1\./)
+
+  t.cucumber_opts = "--color --tags ~@wip #{exempt_tags} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
+end
+
+require 'rake/clean'
+
+desc "Run tests, both RSpec and Cucumber"
+#task :test => [:spec, :cucumber]
+task :test => [:cucumber]

data/fixtures/basic-app/config.rb

@@ -0,0 +1 @@
+activate :twitter_oembed

data/fixtures/basic-app/source/index.html.erb

@@ -0,0 +1,5 @@
+---
+title: Top
+---
+
+Welcome

data/lib/middleman-twitter-oembed.rb

@@ -0,0 +1,7 @@
+require "middleman-twitter-oembed/version"
+
+::Middleman::Extensions.register(:twitter_oembed) do
+  require 'middleman-twitter-oembed/extension'
+  ::Middleman::TwitterOembed::Extension
+end
+

data/lib/middleman-twitter-oembed/extension.rb

@@ -0,0 +1,46 @@
+require 'middleman-twitter-oembed/helpers'
+require 'middleman-twitter-oembed/interface'
+
+module Middleman
+  module TwitterOembed
+    class Extension < Middleman::Extension
+      option :enable_convert, true
+      option :convert_regex, %r{^https?://twitter.com/[a-zA-Z0-9_]+/status/(\d+)$}
+      option :omit_script, false
+      option :use_cache, true
+      option :cache_dir, ".caches/twitter_oembed"
+      
+      self.defined_helpers = [::Middleman::TwitterOembed::Helpers]
+
+      attr_reader :interface
+      
+      def initialize(app, options_hash={}, &block)
+        super
+        #app.set :twitter_oembed_settings, options
+
+        opts = {
+          use_cache: options.use_cache,
+          cache_dir: options.cache_dir,
+          omit_script: options.omit_script
+        }
+        @interface = Middleman::TwitterOembed::Interface.new(opts)
+        
+        extension = self
+        app.before_render do |body|
+          extension.convert(body)
+        end
+      end
+
+      def convert(body)
+        return unless options.enable_convert
+        
+        #regex = %r{https?://twitter.com/[a-zA-Z0-9_]+/status/(\d+)}
+        regex = options.convert_regex
+        body.gsub(regex){
+          res = @interface.get_tweet($1)
+          res['html']
+        }
+      end
+    end ## class Extension
+  end
+end

data/lib/middleman-twitter-oembed/helpers.rb

@@ -0,0 +1,19 @@
+module Middleman::TwitterOembed
+  module Helpers
+    def twitter_oembed(status_id)
+      ext = extensions[:twitter_oembed]
+      res = ext.interface.get_tweet(status_id)
+      res['html']
+    end
+    alias_method :twitter_oembed_by_status_id, :twitter_oembed
+    
+    def twitter_oembed_by_url(url)
+      regex = %r{https?://twitter.com/[a-zA-Z0-9_]+/status/(\d+)}
+      url =~ regex
+      status_id = $1
+      logger.debug url
+      logger.debug status_id
+      twitter_oembed(status_id)
+    end
+  end ## module Helpers
+end  

data/lib/middleman-twitter-oembed/interface.rb

@@ -0,0 +1,47 @@
+module Middleman::TwitterOembed
+  class Interface
+    include ERB::Util
+    
+    def initialize(options = {})
+      @use_cache = options[:use_cache] || true
+      @cache_dir = options[:cache_dir] || "./caches/twitter_oembed"
+      @omit_script = options[:omit_script] || false
+      
+      @result_cache = {}
+    end
+    def get_tweet(status_id)
+      return @result_cache[status_id] if @result_cache.has_key?(status_id)
+      return @result_cache[status_id] = load_cache(status_id) if @use_cache && File.exist?(cache_filename(status_id))
+      
+      url = "https://api.twitter.com/1/statuses/oembed.json?id=#{h(status_id)}"
+      url += "&omit_script=true" if @omit_script
+      begin
+        require 'open-uri'
+        require 'json'
+
+        res = JSON.parse(open(url).read)
+        ## yet to rescue
+      end
+
+      @result_cache[status_id] = res
+      save_cache(status_id, res) if @use_cache
+
+      return res
+    end
+    private
+    def cache_filename(status_id)
+      File.join(@cache_dir, status_id)
+    end
+    def load_cache(status_id)
+      Marshal.load(File.read(cache_filename(status_id)))
+    end
+    def save_cache(status_id, res)
+      dir = File.dirname(cache_filename(status_id))
+
+      require 'fileutils'
+      FileUtils.mkdir_p(dir) unless File.exists?(dir)
+      File.open(cache_filename(status_id), 'wb'){|f| f.write(Marshal.dump(res))}
+    end
+  end
+end
+

data/lib/middleman-twitter-oembed/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module TwitterOembed
+    VERSION = "0.1.0"
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1,2 @@
+require 'middleman-twitter-oembed'
+

data/middleman-twitter-oembed.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-twitter-oembed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-twitter-oembed"
+  spec.version       = Middleman::TwitterOembed::VERSION
+  spec.authors       = ["Ataru Kodaka"]
+  spec.email         = ["ataru.kodaka@gmail.com"]
+
+  spec.summary       = %q{An extension for middleman to render twittr oembed status}
+  spec.description   = %q{An extension for middleman to render twittr oembed status}
+  spec.homepage      = "http://github.com/atarukodaka/middleman-twitter-oembed"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("middleman-core", "~> 3.2")
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "cucumber", "~> 1.3"
+  spec.add_development_dependency "aruba", "~> 0.6"
+  spec.add_development_dependency "therubyracer", "~>0.12"
+  spec.add_development_dependency "pry-byebug", "~>3.1"
+  spec.add_development_dependency "rb-readline", "~>0.5"
+  spec.add_development_dependency "middleman-pry", "~>0.0"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: middleman-twitter-oembed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ataru Kodaka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: middleman-pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: An extension for middleman to render twittr oembed status
+email:
+- ataru.kodaka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- fixtures/basic-app/config.rb
+- fixtures/basic-app/source/index.html.erb
+- lib/middleman-twitter-oembed.rb
+- lib/middleman-twitter-oembed/extension.rb
+- lib/middleman-twitter-oembed/helpers.rb
+- lib/middleman-twitter-oembed/interface.rb
+- lib/middleman-twitter-oembed/version.rb
+- lib/middleman_extension.rb
+- middleman-twitter-oembed.gemspec
+homepage: http://github.com/atarukodaka/middleman-twitter-oembed
+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.6
+signing_key: 
+specification_version: 4
+summary: An extension for middleman to render twittr oembed status
+test_files: []
+has_rdoc: