social_plus-web_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 478a90847f6f39922aa12fc9f1712da864e5af9d
+  data.tar.gz: ccfa4efaede205efb439c1886773b1f956f167a1
+SHA512:
+  metadata.gz: f0775913c356fc0cb0df82688633624e516d4efbf0f1cd2494ce06b56e02f84b5a986d0cec74116af1c24a762f7e2eccc38b2f0aed7a80fa48150cf15469b0b3
+  data.tar.gz: 0ce553e92923ed27fe2bec14264b7afa2297675419fee39ee95f09398d570e11d0b91b60122a124941c1b9acfe2835ad9df0c0889a26c911a3be4c26cbd470a4

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,75 @@
+AllCops:
+  Exclude:
+    - bin/*
+    - db/schema.rb
+    - vendor/**/*
+
+#Metrics/AbcSize:
+#  Max: 52
+
+Metrics/LineLength:
+  Max: 192
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/ExtraSpacing:
+  Enabled: true
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+
+Style/FormatString:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/InlineComment:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ExtraSpacing:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 feedforce Inc.
+
+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,55 @@
+# SocialPlus::WebApi
+
+[![Travis Status](https://img.shields.io/travis/feedforce/social_plus-web_api.svg?style=flat-square)][travisci]
+[![License](https://img.shields.io/github/license/feedforce/social_plus-web_api.svg?style=flat-square)][license]
+[![Gem](https://img.shields.io/gem/v/social_plus-web_api.svg?style=flat-square)][gem-link]
+
+[travisci]: https://travis-ci.org/feedforce/social_plus-web_api
+[license]: https://github.com/feedforce/social_plus-web_api/blob/master/LICENSE.txt
+[gem-link]: http://badge.fury.io/rb/social_plus-web_api
+
+This gem provides fundamental access to Social Plus's Web API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'social_plus-web_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install social_plus-web_api
+
+## Usage
+
+Instantiate an instance of {SocialPlus::WebApi::Client} with a valid API key.
+
+```ruby
+client = SocialPlus::WebApi::Client.new(API_KEY)
+```
+
+### API access via GET method
+
+```ruby
+begin
+  result = client.execute(:api_name, arguments_as_hash)
+rescue SocialPlus::WebApi::ApiError => e
+  # handle exceptions
+end
+```
+
+### API access via POST method
+
+```ruby
+begin
+  result = client.execute(:api_name, arguments_as_hash, via: :post)
+rescue SocialPlus::WebApi::ApiError => e
+  # handle exceptions
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+Dir[File.join(__dir__, 'lib/tasks/*.rake')].each(&method(:load))

data/lib/social_plus/web_api.rb

@@ -0,0 +1,12 @@
+# :nodoc:
+module SocialPlus
+  # :nodoc:
+  module WebApi
+  end
+end
+
+require 'social_plus/web_api/version'
+require 'social_plus/web_api/api_error'
+require 'social_plus/web_api/client'
+require 'social_plus/web_api/user'
+require 'social_plus/web_api/profile'

data/lib/social_plus/web_api/api_error.rb

@@ -0,0 +1,50 @@
+require 'net/http'
+
+# :nodoc:
+module SocialPlus
+  # :nodoc:
+  module WebApi
+    # An Exception class which wraps errors from SocialPlus Web API
+    class ApiError < StandardError
+      # @overload initialize(error)
+      #   @param error [Hash] a Hash which represents an API error
+      #   @option error [String] message the error message
+      #   @option error [Integer] code the error code
+      def initialize(error)
+        super(error['message'])
+        @code = error['code']
+      end
+
+      # @return [Integer] the error code (API error code or HTTP status)
+      attr_reader :code
+    end
+
+    require 'social_plus/web_api/invalid_token'
+    require 'social_plus/web_api/http_response_error'
+
+    class ApiError < StandardError
+      EXCEPTION_CLASSES = Hash.new(ApiError).tap do |exception_classes|
+        exception_classes[4] = InvalidToken
+      end
+
+      def self.exception_from_api_result(response, result)
+        if social_plus_error?(response, result)
+          error = result['error']
+          raise EXCEPTION_CLASSES[error['code']], error
+        else
+          raise HttpResponseError, response
+        end
+      end
+
+      private
+      def self.social_plus_error?(response, result)
+        case response
+        when Net::HTTPServerError, Net::HTTPClientError
+          result.key?('error') && %w(message code).all? { |key| result['error'].key?(key) }
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/social_plus/web_api/client.rb

@@ -0,0 +1,85 @@
+require 'json'
+require 'uri'
+require 'net/https'
+
+require 'active_support/core_ext/object/to_query'
+require 'active_support/core_ext/hash/except'
+
+require 'social_plus/web_api/api_error'
+require 'social_plus/web_api/invalid_token'
+require 'social_plus/web_api/version'
+
+# :nodoc:
+module SocialPlus
+  # :nodoc:
+  module WebApi
+    # A class which wraps calls to Social Plus Web API
+    class Client
+      API_KEY_RE = /\A[0-9a-f]{40}\z/
+      private_constant :API_KEY_RE
+
+      # @param [String] api_key A Social Plus API key
+      # @raise [ArgumentError] when `api_key` is invalid
+      def initialize(api_key)
+        raise ArgumentError, 'invalid API key' unless API_KEY_RE =~ api_key
+        @api_key = api_key.freeze
+        freeze
+      end
+
+      # Executes a Social Plus Web API
+      #
+      # @param [String, Symbol] method An API method name
+      # @param [Hash] parameters Parameters to API except `key`
+      # @option parameters [Symbol] :via HTTP method(default `:get`)
+      # @return [Hash] a Hash generated by parsing the JSON returned from the API call, except `status`,
+      #   just `{}` on parsing failure
+      # @raise [ApiError] when the API returns a status other than 200 OK
+      def execute(method, parameters={})
+        parameters = parameters.with_indifferent_access
+        http_method = parameters.delete(:via) || :get
+        response = request(http_method, method, parameters.merge(key: @api_key))
+        result = parse_as_json(response.body)
+
+        ApiError.exception_from_api_result(response, result) unless response.is_a?(Net::HTTPOK)
+
+        result.except('status')
+      end
+
+      SOCIAL_PLUS_FQDN = URI('https://api.socialplus.jp/')
+      private_constant :SOCIAL_PLUS_FQDN
+
+      USER_AGENT = 'SocialPlus Web API gem/%s' % VERSION
+      private_constant :USER_AGENT
+
+      private
+      def request(http_method, api_method, parameters)
+        uri = request_uri(api_method)
+        request = send("create_#{http_method.downcase}_request", uri.path, parameters)
+        Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          http.request(request)
+        end
+      end
+
+      def create_get_request(path, parameters)
+        Net::HTTP::Get.new(path + '?' + parameters.to_query, 'User-Agent' => USER_AGENT)
+      end
+
+      def create_post_request(path, parameters)
+        Net::HTTP::Post.new(path, 'User-Agent' => USER_AGENT).tap { |request| request.body = parameters.to_query }
+      end
+
+      def request_uri(method)
+        SOCIAL_PLUS_FQDN.dup.tap do |uri|
+          uri.path = '/api/%s' % method
+        end
+      end
+
+      def parse_as_json(json_text)
+        json_text ||= '{}'
+        JSON.parse(json_text)
+      rescue JSON::ParserError
+        {}
+      end
+    end
+  end
+end

data/lib/social_plus/web_api/http_response_error.rb

@@ -0,0 +1,18 @@
+# :nodoc:
+module SocialPlus
+  # :nodoc:
+  module WebApi
+    # An Exception class raised when SocialPlus Web API reports http response error
+    #
+    class HttpResponseError < ApiError
+      # @overload initialize(response)
+      #   @param response [Net::HTTPResponse] HTTP Response (except 200 OK)
+      def initialize(response)
+        super(
+          'message' => response.message,
+          'code'    => response.code.to_i
+        )
+      end
+    end
+  end
+end

data/lib/social_plus/web_api/invalid_token.rb

@@ -0,0 +1,8 @@
+# :nodoc:
+module SocialPlus
+  # :nodoc:
+  module WebApi
+    # An Exception class raised when SocialPlus Web API reports invalid token
+    class InvalidToken < ApiError; end
+  end
+end

data/lib/social_plus/web_api/prefectures.rb

@@ -0,0 +1,55 @@
+# :nodoc:
+module SocialPlus
+  # :nodoc:
+  module WebApi
+    PREFECTURES = {
+      1 => '北海道',
+      2 => '青森県',
+      3 => '岩手県',
+      4 => '宮城県',
+      5 => '秋田県',
+      6 => '山形県',
+      7 => '福島県',
+      8 => '茨城県',
+      9 => '栃木県',
+      10 => '群馬県',
+      11 => '埼玉県',
+      12 => '千葉県',
+      13 => '東京都',
+      14 => '神奈川県',
+      15 => '新潟県',
+      16 => '富山県',
+      17 => '石川県',
+      18 => '福井県',
+      19 => '山梨県',
+      20 => '長野県',
+      21 => '岐阜県',
+      22 => '静岡県',
+      23 => '愛知県',
+      24 => '三重県',
+      25 => '滋賀県',
+      26 => '京都府',
+      27 => '大阪府',
+      28 => '兵庫県',
+      29 => '奈良県',
+      30 => '和歌山県',
+      31 => '鳥取県',
+      32 => '島根県',
+      33 => '岡山県',
+      34 => '広島県',
+      35 => '山口県',
+      36 => '徳島県',
+      37 => '香川県',
+      38 => '愛媛県',
+      39 => '高知県',
+      40 => '福岡県',
+      41 => '佐賀県',
+      42 => '長崎県',
+      43 => '熊本県',
+      44 => '大分県',
+      45 => '宮崎県',
+      46 => '鹿児島県',
+      47 => '沖縄県'
+    }
+  end
+end

data/lib/social_plus/web_api/profile.rb

@@ -0,0 +1,196 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/inclusion'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/string/conversions'
+
+require 'social_plus/web_api/prefectures'
+
+# :nodoc:
+module SocialPlus
+  # :nodoc:
+  module WebApi
+    # rubocop: disable Metrics/ClassLength, Metrics/AbcSize
+
+    # A class which represents authenticated user's information(profile and email) obtained from Social Plus
+    class Profile
+      # rubocop: disable Metrics/MethodLength
+
+      # @param [Hash<String,Object>] params a user's information obtained from Social Plus.
+      # @option params [Hash] "profile" profile of a user
+      # @option params [Array] "email" email addresses of a user
+
+      def initialize(params)
+        params = params.with_indifferent_access
+
+        profile = params[:profile]
+        @full_name, @given_name, @family_name, @full_name_kana, @given_name_kana, @family_name_kana = extract_names(profile).freeze
+        @zip_code = profile[:postal_code]
+        @prefecture, @prefecture_name, @city, @location = extract_location(profile).freeze
+        @gender = profile[:gender].in?([1, 2]) ? profile[:gender] : nil
+        @urls = profile[:uri].respond_to?(:map) ? filter_http_urls(profile[:uri]) : []
+        @birthday = /\A\d{4}-\d{2}-\d{2}\z/ =~ profile[:birthday] ? profile[:birthday].try(:to_date).freeze : nil
+
+        emails = params[:email]
+        @emails = emails && emails.respond_to?(:map) ? emails.map { |email| email[:email].freeze }.compact.freeze : []
+
+        freeze
+      end
+      # rubocop: enable Metrics/MethodLength
+
+      # @return [String] Returns the user's full name
+      attr_reader :full_name
+
+      # @return [String] Returns the user's family name
+      attr_reader :family_name
+
+      # @return [String] Returns the user's given name
+      attr_reader :given_name
+
+      # @return [String] Returns the user's full name in kana
+      attr_reader :full_name_kana
+
+      # @return [String] Returns the user's family name in kana
+      attr_reader :family_name_kana
+
+      # @return [String] Returns the user's given name in kana
+      attr_reader :given_name_kana
+
+      # @return [String] Returns the zip code of user's address
+      attr_reader :zip_code
+
+      # @return [Integer] Returns the prefecture code of user's address
+      attr_reader :prefecture
+
+      # @return [String] Returns the name of prefecture of user's address
+      attr_reader :prefecture_name
+
+      # @return [Integer] Returns the city code of user's address
+      attr_reader :city
+
+      # @return [String] Returns the rest of user's address
+      attr_reader :location
+
+      # @return [Date] Returns the user's birthday
+      attr_reader :birthday
+
+      # @return [Array<URI>] Returns the user's URLs
+      attr_reader :urls
+
+      # @return [Integer] Returns the user's gender
+      attr_reader :gender
+
+      # @return [Array<String>] Returns the user's E-Mail addresses
+      attr_reader :emails
+
+      private
+
+      def filter_http_urls(uris)
+        uris.map { |uri_string| URI(uri_string).freeze rescue nil }.select { |url| url.try(:scheme).in?(%w(http https)) }.freeze
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+
+      # @return [Array] Returns Array of full name, given name, family name, full name in kana, given name in kana and family name in kana
+      def extract_names(profile)
+        full_name_kanji = profile[:full_name_kanji] || ''
+        last_name_kanji = profile[:last_name_kanji] || ''
+        first_name_kanji = profile[:first_name_kanji] || ''
+
+        full_name_kana = profile[:full_name_kana] || ''
+        last_name_kana = profile[:last_name_kana] || ''
+        first_name_kana = profile[:first_name_kana] || ''
+
+        full_name = profile[:full_name] || ''
+        last_name = profile[:last_name] || ''
+        first_name = profile[:first_name] || ''
+        user_name = profile[:user_name] || ''
+
+        # NOTE: "".present? #=> false
+
+        # *: set
+        # -: not set
+        #  : no care
+        #     full(K) | last(K) | first(K) | full | last | first | user |
+        # #1  ******* | ******* | ******** |      |      |       |      |
+        # #1  ******* | ******* | -------- |      |      |       |      |
+        # #1  ******* | ------- | ******** |      |      |       |      |
+        # #1'         |         |          | **** | **** | ***** |      |
+        # #1'         |         |          | **** | **** | ----- |      |
+        # #1'         |         |          | **** | ---- | ***** |      |
+        # #2  ------- | ******* | ******** |      |      |       |      |
+        # #2  ------- | ******* | -------- |      |      |       |      |
+        # #2  ------- | ------- | ******** |      |      |       |      |
+        # #2'         |         |          | ---- | **** | ***** |      |
+        # #2'         |         |          | ---- | **** | ----- |      |
+        # #2'         |         |          | ---- | ---- | ***** |      |
+        # #3  ******* | ------- | -------- |      |      |       |      |
+        # #3'         |         |          | **** | ---- | ----- |      |
+        # #4  ------- | ------- | -------- | ---- | ---- | ----- | **** |
+        # #5  ------- | ------- | -------- | ---- | ---- | ----- | ---- |
+
+        # #1
+        if full_name_kanji.present? && (last_name_kanji.present? || first_name_kanji.present?)
+          names = [ full_name_kanji, first_name_kanji, last_name_kanji ]
+        # #1'
+        elsif full_name.present? && (last_name.present? || first_name.present?)
+          names = [ full_name, first_name, last_name ]
+        # #2
+        elsif last_name_kanji.present? || first_name_kanji.present?
+          names = [ [last_name_kanji, first_name_kanji].join(' ').strip, first_name_kanji, last_name_kanji ]
+        # #2'
+        elsif last_name.present? || first_name.present?
+          names = [ [last_name, first_name].join(' ').strip, first_name, last_name ]
+        # #3
+        elsif full_name_kanji.present?
+          names = [ full_name_kanji, '', full_name_kanji ]
+        # #3'
+        elsif full_name.present?
+          names = [ full_name, '', full_name ]
+        # #4
+        elsif user_name.present?
+          names = [ user_name, '', '' ]
+        # #5
+        else
+          names = [ '', '', '' ]
+        end
+
+        if full_name_kana.present? && (last_name_kana.present? || first_name_kana.present?)
+          kana = [ full_name_kana, first_name_kana, last_name_kana ]
+        elsif last_name_kana.present? || first_name_kana.present?
+          kana = [ [last_name_kana, first_name_kana].join(' ').strip, first_name_kana, last_name_kana ]
+        elsif full_name_kana.present?
+          kana = [ full_name_kana, '', full_name_kana ]
+        else
+          kana = [ '', '', '' ]
+        end
+
+        names + kana
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+
+      # @return [Array] Returns prefecture code, prefecture_name, city code and location(rest of the address)
+      def extract_location(profile)
+        location = profile[:location].presence || ''
+
+        city_code = city_code(profile)
+        prefecture_code = city_code ? city_code_to_prefecture_code(city_code) : nil
+        return [ nil, '', nil, location ] unless city_code && prefecture_code
+
+        prefecture_name = PREFECTURES[prefecture_code]
+        location_without_prefecture = location.sub(/\A#{prefecture_name}/, '')
+        [ prefecture_code, prefecture_name, city_code, location_without_prefecture ]
+      end
+
+      def city_code(profile)
+        profile[:location_jis_id].to_i.presence
+      end
+
+      def city_code_to_prefecture_code(city_code)
+        code = city_code / 1000
+        PREFECTURES.key?(code) ? code : nil
+      end
+    end
+    # rubocop: enable Metrics/ClassLength
+  end
+end