tweet_url 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d513978b99ca008a74aaac00d7aca0ef0e7babd
+  data.tar.gz: 0341d3a86d5a4086b5fe361f578ed47d640e7978
+SHA512:
+  metadata.gz: 605953c0fc283f5241dadf28b418b7ec93db6f3511f6112e5e4a9a07b37591f843cd69b9c13c059252989a16b7c212809f47b4b2f0d44bc9dece40c87d9224c1
+  data.tar.gz: 791d5988cff45d838f03fb15a4227ade583e31aeb5dcb6c277dfcab22b2d850059ba65a11592fad461593394a351b03a0979a270e9218f39c05b45dd84dea835

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace  = true
+max_line_length = 120

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+| Q             | A
+| ------------- | ---
+| Bug fix?      | yes/no
+| New feature?  | yes/no
+| BC breaks?    | yes/no
+| Deprecations? | yes/no
+| Tests pass?   | yes/no
+| Fixed tickets | comma-separated list of tickets fixed by the PR, if any
+| License       | MIT
+| Doc PR        | reference to the documentation PR, if any

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+!/.editorconfig
+!/.github
+!/.rspec
+!/.travis.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.2

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+Contributing
+===
+
+1. Fork it ( https://github.com/announce/tweet_url/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/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Kenta Yamamoto
+
+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,45 @@
+TweetUrl
+===
+
+[![Build Status](https://travis-ci.org/announce/tweet_url.svg?branch=master)](https://travis-ci.org/announce/tweet_url)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tweet_url'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tweet_url
+
+## Usage
+
+Simply,
+
+```rb
+require 'tweet_url'
+
+tweet_url = TweetUrl.parse('https://twitter.com/yukihiro_matz/status/755950562227605504')
+tweet_url.username  #=> "yukihiro_matz"
+tweet_url.status_id  #=> 755950562227605504
+```
+
+To handle URL containing multibyte chars, run `gem install addressable` and
+
+```rb
+require 'addressable/uri'
+require 'tweet_url'
+
+tweet_url = TweetUrl.parse(
+  'https://twitter.com/yukihiro_matz/status/755950562227605504#尾骶骨',
+  parser: Addressable::URI)
+tweet_url.username  #=> "yukihiro_matz"
+tweet_url.status_id  #=> 755950562227605504
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/tweet_url/status.rb

@@ -0,0 +1,32 @@
+require 'tweet_url/uri'
+
+module TweetUrl
+  module Status
+
+    # Take a URI string or URI object and return its ID
+    # @example
+    #   status_id = TweetUrl::Status::status_id('https://twitter.com/sferik/status/540897316908331009/')
+    #   status_id #=> 540897316908331009
+    # @param object [Integer, String, URI] An ID, URI, or object.
+    # @return [Integer, NilClass]
+    def self.status_id(object, parser = DEFAULT_PARSER)
+      case object
+        when ::Integer
+          object
+        when ::String
+          Status::status_id(parser.parse(object), parser)
+        when parser
+          Status::status_id(Uri.hashbang_path_or_path(object).split('/'))
+        when Enumerable
+          Uri::find_resource_id(object) {|s| /\Astatus(?:es)?\z/ === s}
+        else
+          nil
+      end
+    end
+
+    def status_id
+      Status::status_id(@url, @parser)
+    end
+
+  end
+end

data/lib/tweet_url/uri.rb

@@ -0,0 +1,20 @@
+module TweetUrl
+  module Uri
+
+    def self.find_resource_id(list, &block)
+      index = list.index(&block)
+      return index if index.nil?
+      target = list[index + 1]
+      target.nil? ? target : target.to_i
+    end
+
+    # @param object [URI]
+    # @return [String]
+    def self.hashbang_path_or_path(object)
+      (not object.fragment.nil? and object.fragment.chars.first == '!') ?
+          object.fragment :
+          object.path
+    end
+  end
+
+end

data/lib/tweet_url/username.rb

@@ -0,0 +1,25 @@
+require 'tweet_url/uri'
+
+module TweetUrl
+  module Username
+    # Take a URI string or URI object and return its username
+    # @param object [String, URI] An ID, URI, or object.
+    # @return [String, NilClass]
+    def self.username(object, parser = DEFAULT_PARSER)
+      case object
+        when ::String
+          Username::username(parser.parse(object), parser)
+        when URI, parser
+          Username::username(Uri.hashbang_path_or_path(object).split('/'))
+        when Enumerable
+          object[1]
+        else
+          nil
+      end
+    end
+
+    def username
+      Username::username(@url, @parser)
+    end
+  end
+end

data/lib/tweet_url/version.rb

@@ -0,0 +1,3 @@
+module TweetUrl
+  VERSION = '0.0.1'.freeze
+end

data/lib/tweet_url.rb

@@ -0,0 +1,35 @@
+require 'uri'
+require 'tweet_url/version'
+require 'tweet_url/username'
+require 'tweet_url/status'
+
+# Extract username and status_id from tweet URL
+# @example
+#   require 'addressable/uri'
+#   require 'tweet_url'
+#   tweet_url = TweetUrl.parse(
+#     'https://twitter.com/yukihiro_matz/status/755950562227605504#尾骶骨',
+#     parser: Addressable::URI)
+#   tweet_url.username  #=> "yukihiro_matz"
+#   tweet_url.status_id  #=> 755950562227605504
+module TweetUrl
+  DEFAULT_PARSER = URI
+
+  class Base
+    include Username
+    include Status
+    attr_accessor :url, :parser
+    def initialize(url, opts = {})
+      @url = url
+      @parser = opts.has_key?(:parser) ? opts[:parser] : DEFAULT_PARSER
+    end
+  end
+
+  # @param  url [String, URI]
+  # @param
+  # @option opts [Object] :parser URI parser such as Addressable::URI
+  def self.parse(url, opts = {})
+    Base.new(url, opts)
+  end
+
+end

data/spec/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'yard'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec'
+end
+
+# gemspec

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'tweet_url'

data/spec/tweet_url/status_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe TweetUrl::Status do
+  Status = TweetUrl::Status
+  describe '.status_id' do
+    let (:status_id) { 540897316908331009 }
+    describe 'takes string URL and extract ID' do
+      subject { Status::status_id("https://twitter.com/sferik/status/#{status_id}/") }
+      it { is_expected.to equal status_id }
+    end
+
+    describe 'takes URL object and extract ID' do
+      subject { Status::status_id(URI.parse("https://twitter.com/sferik/status/#{status_id}/")) }
+      it { is_expected.to equal status_id }
+    end
+
+    describe 'takes integer ID and return ID' do
+      subject { Status::status_id(status_id) }
+      it { is_expected.to equal status_id }
+    end
+
+    describe 'takes URL followed by additional paths, and extract ID' do
+      subject { Status::status_id("https://twitter.com/sferik/status/#{status_id}/photo/1/") }
+      it { is_expected.to equal status_id }
+    end
+
+    describe 'takes plural style URL, and extract ID' do
+      subject { Status::status_id("https://twitter.com/#!/sferik/statuses/#{status_id}/") }
+      it { is_expected.to equal status_id }
+    end
+
+    describe 'takes irrelevant URL and return nil' do
+      subject { Status::status_id('https://example.com/foo/bar/') }
+      it { is_expected.to be_nil }
+    end
+
+    describe 'takes string ID and return nil' do
+      subject { Status::status_id(status_id.to_s) }
+      it { is_expected.to be_nil }
+    end
+
+    describe 'takes no ID URL, and return nil' do
+      subject { Status::status_id('https://twitter.com/sferik/status/') }
+      it { is_expected.to be_nil }
+    end
+
+  end
+
+end

data/spec/tweet_url/username_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe TweetUrl::Username do
+  describe '.username' do
+    let (:username) { 'i05' }
+    describe 'takes string URL and extract username' do
+      subject { TweetUrl::Username::username("https://twitter.com/#{username}/status/658113992410292224") }
+      it { is_expected.to eq username }
+    end
+  end
+end

data/spec/tweet_url_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe TweetUrl do
+
+  it 'has a version number' do
+    expect(TweetUrl::VERSION).not_to be nil
+  end
+
+  let!(:username) { 'i05' }
+  let!(:status_id) { 658113992410292224 }
+
+  describe TweetUrl::Base do
+    let(:tweet_url) { TweetUrl.parse("https://twitter.com/#{username}/status/#{status_id}") }
+
+    it { expect(tweet_url).to be_instance_of(TweetUrl::Base)}
+    it { expect(tweet_url.username).to eq username }
+    it { expect(tweet_url.status_id).to eq status_id }
+  end
+
+  context 'with parser option' do
+    let(:tweet_url) {
+      require 'addressable/uri'
+      TweetUrl.parse(
+        "https://twitter.com/#{username}/status/#{status_id}#マルチバイト",
+        parser: Addressable::URI)
+    }
+
+    it { expect(tweet_url).to be_instance_of(TweetUrl::Base)}
+    it { expect(tweet_url.parser).to be Addressable::URI}
+    it { expect(tweet_url.username).to eq username }
+    it { expect(tweet_url.status_id).to eq status_id }
+  end
+
+end

data/tweet_url.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tweet_url/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tweet_url'
+  spec.version       = TweetUrl::VERSION
+  spec.authors       = ['Kenta Yamamoto']
+  spec.email         = ['ymkjp@jaist.ac.jp']
+  spec.summary       = 'Twitter URL parser'
+  spec.description   = 'Extract username and status_id from tweet URL'
+  spec.homepage      = 'https://github.com/announce/tweet_url'
+  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.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'addressable'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: tweet_url
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kenta Yamamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-11 00:00:00.000000000 Z
+dependencies:
+- !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: 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: addressable
+  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'
+description: Extract username and status_id from tweet URL
+email:
+- ymkjp@jaist.ac.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tweet_url.rb
+- lib/tweet_url/status.rb
+- lib/tweet_url/uri.rb
+- lib/tweet_url/username.rb
+- lib/tweet_url/version.rb
+- spec/Gemfile
+- spec/spec_helper.rb
+- spec/tweet_url/status_spec.rb
+- spec/tweet_url/username_spec.rb
+- spec/tweet_url_spec.rb
+- tweet_url.gemspec
+homepage: https://github.com/announce/tweet_url
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Twitter URL parser
+test_files:
+- spec/Gemfile
+- spec/spec_helper.rb
+- spec/tweet_url/status_spec.rb
+- spec/tweet_url/username_spec.rb
+- spec/tweet_url_spec.rb