rest_uri 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb72238c752bdafc3a8e986139d4e68fc1ea326e
-  data.tar.gz: 0781cbbdac948bf2a65c96827bb025780b5106f7
+  metadata.gz: 8a19b7df93211dc0bb4fdd43bab6748c6a7c2ad5
+  data.tar.gz: cf8df8c962fd7f4b3a6d7ea56d3e83c39661381f
 SHA512:
-  metadata.gz: 5b845d9adbc9117bab76f65c094a8d385253073db5a1258497ef099274236a3428a936a98a345bddfa19be284dfdec444f1f9b57611d5fd95bc33f18089a88b1
-  data.tar.gz: 5464c41caf644a3ffa7d19ccdc47a78f8e9ae64442168b3c2a61778fb329cced37f5c7d74d17ea2051c0fefe357f0ba696940d3a550cd3fd9e2f6db527564192
+  metadata.gz: 804caf8124f65d100e1dad6d02efac8e88b0d1dd439d2a2cbb1328974411f87491b316ecf050068034525222cc994012919d9bb260a6a3009d799594b9353c08
+  data.tar.gz: e012d8066f26706ebe4640bb7a0cc7b1b62a5b9dd4d54014a75d12e3c7cdaeb585a4a25dd3b0950e609a2981a15a27339b32db311bd9d2cd42a70764875cef05

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,6 @@
 | Q             | A
 | ------------- | ---
+| Branch?       | "master"
 | Bug fix?      | yes/no
 | New feature?  | yes/no
 | BC breaks?    | yes/no

data/.gitignore

@@ -1,50 +1,19 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
 /tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
 
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+!/.github/
+!/.editorconfig
+!/.rspec
+!/.travis.yml

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.1
-  - 2.0
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+

data/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 Contributing
 ===
 
-1. Fork it ( https://github.com/announce/tweet_url/fork )
+1. Fork it ( https://github.com/announce/rest_uri/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`)

data/README.md

@@ -2,6 +2,7 @@ RestUri
 ===
 
 [![Build Status](https://travis-ci.org/announce/rest_uri.svg?branch=master)](https://travis-ci.org/announce/rest_uri)
+[![Gem Version](https://badge.fury.io/rb/rest_uri.svg)](https://rubygems.org/gems/rest_uri/)
 
 ## Installation
 

data/lib/rest_uri/resource.rb

@@ -1,38 +1,40 @@
-require 'active_support/inflector'
 require 'rest_uri/uri'
 
 module RestUri
   module Resource
-
     # Take a URI string or URI object and return its ID
     # @example
-    #   resource_id = RestUri::Resource::resource_id('https://twitter.com/sferik/resource/540897316908331009/')
+    #   resource_id = RestUri::Resource.resource_id('https://twitter.com/sferik/resource/540897316908331009/')
     #   resource_id #=> 540897316908331009
     # @param name [String] Resource name
     # @param object [Integer, String, URI] An ID, URI, or object.
+    # @option parser [Integer, String, URI] An ID, URI, or object.
     # @return [Integer, NilClass]
-    def self.resource_id(name, object, parser = DEFAULT_PARSER)
+    def self.resource_id(name, object, parser: DEFAULT_PARSER)
+      return nil if not name.respond_to? :empty? or name.empty?
       case object
         when ::Integer
           object
         when ::String
-          Resource.resource_id(name, parser.parse(object), parser)
+          resource_id(name, parser.parse(object), parser: parser)
         when parser
-          Resource.resource_id(name, Uri.hashbang_path_or_path(object).split('/'))
+          resource_id(name, Uri.hashbang_path_or_path(object).split('/'))
         when Enumerable
-          Uri.find_resource_id(object) {|s| /\A(?:#{name.singularize}|#{name.pluralize})\z/ === s}
+          Uri.find_resource_id(object) {|s|
+            /\A(?:#{name.underscore.singularize}|#{name.underscore.pluralize})\z/ === s
+          }
         else
           nil
       end
     end
 
-    def resource_id(name)
-      Resource.resource_id(name.underscore, @uri, @parser)
+    def resource(name)
+      Resource.resource_id(name, @uri, parser: @parser)
     end
 
     def method_missing(name, *args)
-      super unless name.to_s.end_with? :_id.to_s
-      resource_id(name[0...-:_id.to_s.size])
+      super unless name.to_s.end_with? @identifier.to_s
+      resource(name[0...-@identifier.to_s.size])
     end
 
   end

data/lib/rest_uri/version.rb

@@ -1,3 +1,3 @@
 module RestUri
-  VERSION = '0.0.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/rest_uri.rb

@@ -1,32 +1,38 @@
 require 'uri'
+require 'active_support/inflector'
 require 'rest_uri/version'
 require 'rest_uri/resource'
 
 module RestUri
   DEFAULT_PARSER = URI
+  DEFAULT_IDENTIFIER = :_id
 
   # Retrieve resource ID from REST URI
-  # @example
-  #   require 'addressable/uri'
-  #   require 'rest_uri'
-  #   rest_uri = RestUri.parse(
-  #     'https://twitter.com/yukihiro_matz/status/755950562227605504#尾骶骨',
-  #     parser: Addressable::URI)
-  #   rest_uri.status_id  #=> 755950562227605504
   class Base
     include Resource
-    attr_accessor :uri, :parser
-    def initialize(uri, opts = {})
+    attr_accessor :uri, :parser, :identifier
+    def initialize(uri, parser: DEFAULT_PARSER, identifier: DEFAULT_IDENTIFIER)
+      raise ArgumentError, 'Empty identifier' if not identifier.respond_to? :empty? or identifier.empty?
       @uri = uri
-      @parser = opts.has_key?(:parser) ? opts[:parser] : DEFAULT_PARSER
+      @parser = parser
+      @identifier = identifier
     end
   end
 
+  # Parse REST URI
   # @param  uri [String, URI]
   # @param
-  # @option opts [Object] :parser URI parser such as Addressable::URI
-  def self.parse(uri, opts = {})
-    Base.new(uri, opts)
+  # @option options [Object] :parser URI parser such as Addressable::URI
+  # @option options [Symbol] :identifier Suffix of method name to specify resource
+  # @example
+  #   require 'addressable/uri'
+  #   require 'rest_uri'
+  #   rest_uri = RestUri.parse(
+  #     'https://twitter.com/yukihiro_matz/status/755950562227605504#尾骶骨',
+  #     parser: Addressable::URI)
+  #   rest_uri.status_id  #=> 755950562227605504
+  def self.parse(uri, **options)
+    Base.new(uri, options)
   end
 
 end

data/spec/rest_uri/resource_spec.rb

@@ -14,16 +14,36 @@ describe RestUri::Resource do
       it { is_expected.to equal status_id }
     end
 
-    describe 'takes URL string and plural name' do
+    describe 'takes plural name and return resource ID' do
       subject { resource.resource_id('statuses', "https://twitter.com/sferik/status/#{status_id}/") }
       it { is_expected.to equal status_id }
     end
 
-    describe 'takes URL object and extract ID' do
-      subject { resource.resource_id('statuses', "https://twitter.com/sferik/status/#{status_id}/") }
+    describe 'takes capital case name and return resource ID' do
+      subject { resource.resource_id('Status', "https://twitter.com/sferik/status/#{status_id}/") }
+      it { is_expected.to equal status_id }
+    end
+
+    describe 'takes camel case name and return resource ID' do
+      subject { resource.resource_id('UserStatus', "https://twitter.com/sferik/user_status/#{status_id}/") }
+      it { is_expected.to equal status_id }
+    end
+
+    describe 'takes underscored name and return resource ID' do
+      subject { resource.resource_id('user_status', "https://twitter.com/sferik/user_status/#{status_id}/") }
       it { is_expected.to equal status_id }
     end
 
+    describe 'takes unknown resource name' do
+      subject { resource.resource_id('foo', "https://twitter.com/sferik/status/#{status_id}/") }
+      it { is_expected.to be_nil }
+    end
+
+    describe 'takes empty resource name' do
+      subject { resource.resource_id('', "https://twitter.com/sferik/status/#{status_id}/") }
+      it { is_expected.to be_nil }
+    end
+
   end
 
 end

data/spec/rest_uri_spec.rb

@@ -8,35 +8,53 @@ describe RestUri do
 
   let!(:username) { 'i05' }
   let!(:status_id) { 658113992410292224 }
+  let!(:photo_id) { 1 }
 
-  describe RestUri::Base do
-    context 'Singular resource' do
-      let(:tweet_url) { RestUri.parse("https://twitter.com/#{username}/status/#{status_id}") }
-      it { expect(tweet_url).to be_instance_of(RestUri::Base)}
-      it { expect(tweet_url.status_id).to eq status_id }
-      it { expect(tweet_url.statuses_id).to eq status_id }
-    end
-
-    context 'Plural resource' do
-      let(:tweet_url) { RestUri.parse("https://twitter.com/#{username}/status/#{status_id}") }
-      it { expect(tweet_url).to be_instance_of(RestUri::Base)}
-      it { expect(tweet_url.status_id).to eq status_id }
-      it { expect(tweet_url.statuses_id).to eq status_id }
-    end
+  context 'with singular resource' do
+    subject(:rest_uri) { RestUri.parse("https://twitter.com/#{username}/status/#{status_id}") }
+    it { expect(rest_uri).to be_instance_of(RestUri::Base)}
+    it { expect(rest_uri.status_id).to eq status_id }
+    it { expect(rest_uri.statuses_id).to eq status_id }
+  end
+
+  context 'with plural resource' do
+    subject(:rest_uri) { RestUri.parse("https://twitter.com/#{username}/statuses/#{status_id}") }
+    it { expect(rest_uri).to be_instance_of(RestUri::Base)}
+    it { expect(rest_uri.status_id).to eq status_id }
+    it { expect(rest_uri.statuses_id).to eq status_id }
+  end
 
+  context 'with multiple resources' do
+    subject(:rest_uri) { RestUri.parse("https://twitter.com/#{username}/status/#{status_id}/photo/#{photo_id}") }
+    it { expect(rest_uri).to be_instance_of(RestUri::Base)}
+    it { expect(rest_uri.status_id).to eq status_id }
+    it { expect(rest_uri.photo_id).to eq photo_id }
   end
 
   context 'with parser option' do
-    let(:tweet_url) {
+    subject(:rest_uri) {
       require 'addressable/uri'
+      RestUri.parse("https://漢字.com/#{username}/status/#{status_id}", parser: Addressable::URI)
+    }
+    it { expect(rest_uri).to be_instance_of(RestUri::Base)}
+    it { expect(rest_uri.parser).to be Addressable::URI}
+    it { expect(rest_uri.status_id).to eq status_id }
+  end
+
+  context 'with identifier option' do
+    subject(:rest_uri) {
       RestUri.parse(
-        "https://twitter.com/#{username}/status/#{status_id}#マルチバイト",
-        parser: Addressable::URI)
+        "https://example.com/#{username}/status/#{status_id}",
+        identifier: :_foo)
     }
+    it { expect(rest_uri).to be_instance_of(RestUri::Base)}
+    it { expect(rest_uri.status_foo).to eq status_id }
 
-    it { expect(tweet_url).to be_instance_of(RestUri::Base)}
-    it { expect(tweet_url.parser).to be Addressable::URI}
-    it { expect(tweet_url.status_id).to eq status_id }
+    subject(:empty_identifier) {
+      RestUri.parse(
+        "https://example.com/#{username}/status/#{status_id}",
+        identifier: :'')
+    }
+    it { expect {empty_identifier}.to raise_error(ArgumentError)}
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest_uri
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kenta Yamamoto
@@ -94,8 +94,6 @@ files:
 - ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rest_uri (0.0.1)
-      activesupport (~> 5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.0.0.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.4.0)
-    concurrent-ruby (1.0.2)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    minitest (5.9.0)
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.2)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  addressable
-  bundler (~> 1.7)
-  rake (~> 10.0)
-  rest_uri!
-  rspec
-
-BUNDLED WITH
-   1.12.5

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2016 
-
-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.