ids_please 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 828c4e253714ec465733c938e21b05fc32424328
-  data.tar.gz: ea65f9b285ed018eae2e4f9f4c6f49fabee2535d
+  metadata.gz: 7779235b8c59f4d9358aa29c286841278d15bf5d
+  data.tar.gz: 7295b6fcadf9aac2394dbd938df565b22078dcab
 SHA512:
-  metadata.gz: ae6eed3675cf44e11e658d89a7ba4493bbb57bcf75264d300e1e88ede43b0c85acfc75106554a38521866fb13134a84884cbbbdd5b449281e57ee7902afd3042
-  data.tar.gz: 68bd1add5001dea4def229ab4abf2bb98327a293764aa69ac648e10615fb29ed183b124959518135e1e1b2be279f27b5716ac655e446b05f03abcdc6c3134714
+  metadata.gz: 1211b6e2d5f4c70b5d8ddf96d7cf9e94bafe85c01ee5ebd8416b4c03eca139401dc262c955ee43a5cdee9df373726ebb9b8eac40e97ab851a2dc5e352b3dce06
+  data.tar.gz: 890bbc710aabcfefaa89fb3674896f2c024c9bce2e0cc9ef57cb0a0dd9f1e8e9ec8971e271baf09dfe87cf87031a41e332235120ad15fbf8357750ebb7b28312

data/README.md

@@ -1,4 +1,72 @@
-ids_please
-==========
+# IDs, please
 
-Helps to get ids or screen names from links to social network accounts
+Get social network IDs or screen names from links to social network accounts.
+
+Sometimes you need to get a social network account name from a link —
+to store a screen name in yor database instead of parsing the link every time,
+or maybe to work with these accounts using social network APIs (as I do).
+Would be easier to have a library that extracts this kind of information
+from all known social networks for your pleasure.
+
+Sponsored by [Evil Martians](http://evilmartians.com).
+
+## Installation
+
+```bash
+gem install ids_please
+```
+
+Or, put this in your Gemfile:
+
+```ruby
+gem 'ids_please'
+```
+
+## Usage
+
+This is how you get social IDs from from links:
+
+```ruby
+ids = IdsPlease.new('https://twitter.com/gazay', 'http://facebook.com/alexey.gaziev')
+ids.parse
+puts ids.parsed['Twitter']  # => ["gazay"]
+puts ids.parsed['Facebook'] # => ["alexey.gaziev"]
+
+puts ids.original           # => ["https://twitter.com/gazay", "http://facebook.com/alexey.gaziev"]
+```
+
+Or you can just check that the link is for a known social network:
+
+```ruby
+ids = IdsPlease.new('https://twitter.com/gazay', 'http://some-unknown-network.com/gazay')
+ids.recognize
+puts ids.recognized   # => {"Twitter"=>[#<URI::HTTP:0x007fea3bba7e30 URL:http://twitter.com/gazay>]}
+puts ids.unrecognized # => ["http://some-unknown-network.com/gazay"]
+```
+
+Social networks supported at the moment:
+
+* Facebook
+* Twitter
+* Instagram
+* Soundcloud
+* GooglePlus
+* Youtube
+* Tumblr
+* Vimeo
+* Vkontakte
+* Odnoklassniki
+
+## Contributors
+
+* @gazay
+
+Special thanks to @ai, @yaroslav, @whitequark
+
+## Notes
+
+Gem named under an impression of an awesome game called [Papers, please](http://papersplea.se/)
+
+## License
+
+The MIT License

data/lib/ids_please/base_parser.rb

@@ -1,15 +1,19 @@
-class IdsPlease::BaseParser
+class IdsPlease
+  class BaseParser
 
-  def self.network_name
-    self.name.split('::').last
-  end
+    def self.to_sym
+      self.name.split('::').last.downcase.to_sym
+    end
 
-  def self.parse(links)
-    links.map { |l| parse_link(l) }.compact
-  end
+    def self.parse(links)
+      links.map { |l| parse_link(l) }.compact
+    end
 
-  def self.parse_link(link)
-    link.path.split('/')[1]
-  end
+    private
 
+    def self.parse_link(link)
+      link.path.split('/')[1]
+    end
+
+  end
 end

data/lib/ids_please/facebook.rb

@@ -1,16 +1,18 @@
-class IdsPlease::Facebook < IdsPlease::BaseParser
+class IdsPlease
+  class Facebook < IdsPlease::BaseParser
 
-  MASK = /fb\.me|fb\.com|facebook/i
+    MASK = /fb\.me|fb\.com|facebook/i
 
-  def self.parse_link(link)
-    if link.query && !link.query.empty?
-      query = CGI.parse(link.query)
-      query['id'].first if query.keys.include?('id')
-    elsif link.path =~ /\/pages\//
-      link.path.split('/').last
-    else
-      link.path.split('/')[1]
+    def self.parse_link(link)
+      if link.query && !link.query.empty?
+        query = CGI.parse(link.query)
+        query['id'].first if query.keys.include?('id')
+      elsif link.path =~ /\/pages\//
+        link.path.split('/').last
+      else
+        link.path.split('/')[1]
+      end
     end
-  end
 
+  end
 end

data/lib/ids_please/google_plus.rb

@@ -1,18 +1,26 @@
-class IdsPlease::GooglePlus < IdsPlease::BaseParser
+class IdsPlease
+  class GooglePlus < IdsPlease::BaseParser
 
-  MASK = /google/i
+    MASK = /google/i
 
-  def self.parse(links)
-    links.map { |l| parse_link(l) }.compact
-  end
+    def self.to_sym
+      :google_plus
+    end
 
-  def self.parse_link(link)
-    if link.host == 'google.com'
-      link.path.split('/')[1]
-    else
-      matched = link.path.match(/\/(\d{2,})/)
-      matched[1] if matched
+    def self.parse(links)
+      links.map { |l| parse_link(l) }.compact
     end
-  end
 
+    private
+
+    def self.parse_link(link)
+      if link.host == 'google.com'
+        link.path.split('/')[1]
+      else
+        matched = link.path.match(/\/(\d{2,})/)
+        matched[1] if matched
+      end
+    end
+
+  end
 end

data/lib/ids_please/instagram.rb

@@ -1,5 +1,7 @@
-class IdsPlease::Instagram < IdsPlease::BaseParser
+class IdsPlease
+  class Instagram < IdsPlease::BaseParser
 
-  MASK = /instagr/i
+    MASK = /instagr/i
 
+  end
 end

data/lib/ids_please/odnoklassniki.rb

@@ -1,13 +1,15 @@
-class IdsPlease::Odnoklassniki < IdsPlease::BaseParser
+class IdsPlease
+  class Odnoklassniki < IdsPlease::BaseParser
 
-  MASK = /odnoklassniki/i
+    MASK = /odnoklassniki/i
 
-  def self.parse_link(link)
-    if link.path =~ /\/profile\//
-      link.path.split('/').last
-    elsif link.path.split('/').size == 2
-      link.path.split('/').last
+    def self.parse_link(link)
+      if link.path =~ /\/profile\//
+        link.path.split('/').last
+      elsif link.path.split('/').size == 2
+        link.path.split('/').last
+      end
     end
-  end
 
+  end
 end

data/lib/ids_please/soundcloud.rb

@@ -1,5 +1,7 @@
-class IdsPlease::Soundcloud < IdsPlease::BaseParser
+class IdsPlease
+  class Soundcloud < IdsPlease::BaseParser
 
-  MASK = /snd\.cc|soundcloud/i
+    MASK = /snd\.cc|soundcloud/i
 
+  end
 end

data/lib/ids_please/tumblr.rb

@@ -1,16 +1,18 @@
-class IdsPlease::Tumblr < IdsPlease::BaseParser
+class IdsPlease
+  class Tumblr < IdsPlease::BaseParser
 
-  MASK = /tumblr/i
+    MASK = /tumblr/i
 
-  def self.parse(links)
-    links.map do |link|
-      next if link.host.sub('.tumblr.com', '') == link.host
-      parse_link(link)
-    end.compact
-  end
+    def self.parse(links)
+      links.map do |link|
+        next if link.host.sub('.tumblr.com', '') == link.host
+        parse_link(link)
+      end.compact
+    end
 
-  def self.parse_link(link)
-    link.host.sub('.tumblr.com', '')
-  end
+    def self.parse_link(link)
+      link.host.sub('.tumblr.com', '')
+    end
 
+  end
 end

data/lib/ids_please/twitter.rb

@@ -1,14 +1,16 @@
-class IdsPlease::Twitter < IdsPlease::BaseParser
+class IdsPlease
+  class Twitter < IdsPlease::BaseParser
 
-  MASK = /twitter/i
+    MASK = /twitter/i
 
-  def self.parse_link(link)
-    if link.path =~ /%23!/
-      id = link.path.sub(/\A\/%23!\//, '')
-      id.split(/[\/\?#]/).first
-    else
-      link.path.split('/')[1]
+    def self.parse_link(link)
+      if link.path =~ /%23!/
+        id = link.path.sub(/\A\/%23!\//, '')
+        id.split(/[\/\?#]/).first
+      else
+        link.path.split('/')[1]
+      end
     end
-  end
 
+  end
 end

data/lib/ids_please/vimeo.rb

@@ -1,5 +1,7 @@
-class IdsPlease::Vimeo < IdsPlease::BaseParser
+class IdsPlease
+  class Vimeo < IdsPlease::BaseParser
 
-  MASK = /vimeo/i
+    MASK = /vimeo/i
 
+  end
 end

data/lib/ids_please/vkontakte.rb

@@ -1,18 +1,20 @@
-class IdsPlease::Vkontakte < IdsPlease::BaseParser
+class IdsPlease
+  class Vkontakte < IdsPlease::BaseParser
 
-  MASK = /vk\.com|vkontakte/i
+    MASK = /vk\.com|vkontakte/i
 
-  def self.parse(links)
-    links.map { |l| parse_link(l) }.compact
-  end
+    def self.parse(links)
+      links.map { |l| parse_link(l) }.compact
+    end
 
-  def self.parse_link(link)
-    if link.path =~ /id|club/
-      id = link.path.sub(/\A\/id|\A\/club/, '')
-      id.split(/[\/\?#]/).first
-    else
-      link.path.split('/')[1]
+    def self.parse_link(link)
+      if link.path =~ /id|club/
+        id = link.path.sub(/\A\/id|\A\/club/, '')
+        id.split(/[\/\?#]/).first
+      else
+        link.path.split('/')[1]
+      end
     end
-  end
 
+  end
 end

data/lib/ids_please/youtube.rb

@@ -1,13 +1,15 @@
-class IdsPlease::Youtube < IdsPlease::BaseParser
+class IdsPlease
+  class Youtube < IdsPlease::BaseParser
 
-  MASK = /youtu\.be|youtube/i
+    MASK = /youtu\.be|youtube/i
 
-  def self.parse_link(link)
-    if link.path =~ /channels/
-      link.path.split('/')[2]
-    else
-      link.path.split('/')[1]
+    def self.parse_link(link)
+      if link.path =~ /channels/
+        link.path.split('/')[2]
+      else
+        link.path.split('/')[1]
+      end
     end
-  end
 
+  end
 end

data/lib/ids_please.rb

@@ -1,28 +1,38 @@
 require 'uri'
 require 'cgi'
+require_relative 'ids_please/base_parser'
+require_relative 'ids_please/facebook'
+require_relative 'ids_please/google_plus'
+require_relative 'ids_please/instagram'
+require_relative 'ids_please/twitter'
+require_relative 'ids_please/tumblr'
+require_relative 'ids_please/vimeo'
+require_relative 'ids_please/youtube'
+require_relative 'ids_please/soundcloud'
+require_relative 'ids_please/vkontakte'
+require_relative 'ids_please/odnoklassniki'
 
 class IdsPlease
 
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 
-  attr_accessor :original, :recognized, :unrecognized, :options, :parsed
+  attr_accessor :original, :recognized, :unrecognized, :parsed
 
-  SOCIAL_NETWORKS = %w(
-    GooglePlus
-    Vkontakte
-    Twitter
-    Facebook
-    Instagram
-    Soundcloud
-    Vimeo
-    Youtube
-    Odnoklassniki
-    Tumblr
-  )
+  SOCIAL_NETWORKS = [
+    IdsPlease::GooglePlus,
+    IdsPlease::Vkontakte,
+    IdsPlease::Twitter,
+    IdsPlease::Facebook,
+    IdsPlease::Instagram,
+    IdsPlease::Soundcloud,
+    IdsPlease::Vimeo,
+    IdsPlease::Youtube,
+    IdsPlease::Odnoklassniki,
+    IdsPlease::Tumblr
+  ]
 
   def initialize(*args)
     duped_args = args.dup
-    @options = duped_args.pop if duped_args.last.is_a?(Hash)
     @original = duped_args
   end
 
@@ -35,38 +45,27 @@ class IdsPlease
   def parse
     recognize
     @parsed = {}
-    recognized.each do |klass_name, links|
-      @parsed[klass_name] ||= []
-      @parsed[klass_name] += parser(klass_name).parse(links)
+    recognized.each do |network_sym, links|
+      parser = SOCIAL_NETWORKS.find { |sn| sn.to_sym == network_sym }
+
+      @parsed[network_sym] ||= []
+      @parsed[network_sym] += parser.parse(links)
     end
   end
 
   private
 
   def recognize_link(link)
-    network, handle = nil
     link = "http://#{link}" unless link =~ /\Ahttps?:\/\//
     parsed_link = URI(URI.encode(link))
     SOCIAL_NETWORKS.each do |network|
-      if parsed_link.host =~ parser(network)::MASK
-        recognized[network] ||= []
-        recognized[network] << parsed_link
+      if parsed_link.host =~ network::MASK
+        recognized[network.to_sym] ||= []
+        recognized[network.to_sym] << parsed_link
         return
       end
     end
     unrecognized << link
   end
 
-  def parser(name)
-    "IdsPlease::#{name}".split('::').inject(Module) do |acc, val|
-      acc.const_get(val)
-    end
-  end
-
-end
-
-require_relative 'ids_please/base_parser'
-Dir[File.dirname(__FILE__) + '/ids_please/*.rb'].each do |file|
-  next if file =~ /base_parser/
-  require file
 end

data/spec/ids_please/basic_spec.rb

@@ -37,39 +37,39 @@ describe IdsPlease do
       end
 
       it 'get right id from facebook link' do
-        expect(@recognizer.parsed['Facebook'].first).to eq('fb_acc')
+        expect(@recognizer.parsed[:facebook].first).to eq('fb_acc')
       end
 
       it 'get right id from instagram link' do
-        expect(@recognizer.parsed['Instagram'].first).to eq('inst_acc')
+        expect(@recognizer.parsed[:instagram].first).to eq('inst_acc')
       end
 
       it 'get right id from vk link' do
-        expect(@recognizer.parsed['Vkontakte'].first).to eq('vk_acc')
+        expect(@recognizer.parsed[:vkontakte].first).to eq('vk_acc')
       end
 
       it 'get right id from twitter link' do
-        expect(@recognizer.parsed['Twitter'].first).to eq('twi_acc')
+        expect(@recognizer.parsed[:twitter].first).to eq('twi_acc')
       end
 
       it 'get right id from vimeo link' do
-        expect(@recognizer.parsed['Vimeo'].first).to eq('vimeo_acc')
+        expect(@recognizer.parsed[:vimeo].first).to eq('vimeo_acc')
       end
 
       it 'get right id from google+ link' do
-        expect(@recognizer.parsed['GooglePlus'].first).to eq('12341234')
+        expect(@recognizer.parsed[:google_plus].first).to eq('12341234')
       end
 
       it 'get right id from soundcloud link' do
-        expect(@recognizer.parsed['Soundcloud'].first).to eq('sc_acc')
+        expect(@recognizer.parsed[:soundcloud].first).to eq('sc_acc')
       end
 
       it 'get right id from youtube link' do
-        expect(@recognizer.parsed['Youtube'].first).to eq('yb_acc')
+        expect(@recognizer.parsed[:youtube].first).to eq('yb_acc')
       end
 
       it 'get right id from tumblr link' do
-        expect(@recognizer.parsed['Tumblr'].first).to eq('tumblr-acc')
+        expect(@recognizer.parsed[:tumblr].first).to eq('tumblr-acc')
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ids_please
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - gazay