kakao-rest-api 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de0f57ef24ccf97384a7dac95ff9796af913bbf1
-  data.tar.gz: c2d83f58c7e7dca065d7c9b62a61795810f04433
+  metadata.gz: 105affffd19f6cc67f3bd6df7c52d2d448f0b79e
+  data.tar.gz: 3a46d5b90e41f2eaa4072f95a81026aacfad9477
 SHA512:
-  metadata.gz: 507bd3442b357be53f2bea8177f1fff916e8a75be6d0360aa41b11190fdd07f62835862fbdf7fda88bde1a4d5f8025e66f856e846c2b183c97712d0a6290093c
-  data.tar.gz: 115752456445a9bd0cd40f6855ae54fd2e8500181ea5d04c4a01ed37c6a780869af38e05f7d02213c57d0b68dc08a9f4cddd53364295edddd03af06b0ff22161
+  metadata.gz: 11fe08ef54072d2056ccbe5e88219927bcfdf1d3efc9dceae1565f14df09696e516adfd20d542d9228550206886b505c81c71539e71b69f5d8bf9bbde1716193
+  data.tar.gz: 19ad641b3841030da0dfa6019c73e94db13116fe25ccc961945d14f9f59b3f0b4159fe8c0579ea3172f3030056d47e5b86e95ce6cfcf5b4f610968f0b3bbb65c

data/lib/kakao-rest-api.rb

@@ -1,14 +1,15 @@
 require 'rest-client'
+require 'v1/user'
+require 'v1/api/story'
+require 'v1/api/talk'
 
 class KakaoRestApi
   attr_accessor :app_key, :admin_key, :authorize_code, :redirect_uri
 
-  STORY_POST_TYPE_NOTE = 0
-  STORY_POST_TYPE_IMAGE = 1
-  STORY_POST_TYPE_LINK = 2
+  HOST_KAUTH = 'https://kauth.kakao.com'.freeze
+  HOST_KAPI = 'https://kapi.kakao.com'.freeze
 
   def initialize(app_key, admin_key, redirect_uri)
-    # raise ArgumentError 'required parameter is blank' if app_key.blank? || admin_key.blank?
     self.app_key = app_key
     self.admin_key = admin_key
     self.redirect_uri = redirect_uri
@@ -18,13 +19,13 @@ class KakaoRestApi
     self.authorize_code = authorize_code
   end
 
-  def login(state=nil, encode_state=nil)
-    # raise ArgumentError 'required parameter is blank' if redirect_uri.blank?
+  def login(state = nil, encode_state = false)
     response_type = 'code'
-    host = 'https://kauth.kakao.com'
     path = "/oauth/authorize?client_id=#{app_key}&redirect_uri=#{redirect_uri}&response_type=#{response_type}"
+    path.concat("&state=#{state}") unless state.nil?
+    path.concat('&encode_state=true') if encode_state
 
-    "#{host}#{path}"
+    "#{HOST_KAUTH}#{path}"
   end
 
   def token
@@ -34,8 +35,7 @@ class KakaoRestApi
       redirect_uri: redirect_uri,
       code: authorize_code
     }
-    
-    request_url = 'https://kauth.kakao.com/oauth/token'
+    request_url = "#{HOST_KAUTH}/oauth/token"
     RestClient.post(request_url, query_params)
   end
 
@@ -45,203 +45,89 @@ class KakaoRestApi
       client_id: app_key,
       refresh_token: refresh_token
     }
-
-    request_url = 'https://kauth.kakao.com/oauth/token'
+    request_url = "#{HOST_KAUTH}/oauth/token"
     RestClient.post(request_url, query_params)
   end
 
   def logout(access_token)
-    authorization = "Bearer #{access_token}"
-
-    request_url = 'https://kapi.kakao.com/v1/user/logout'
-    RestClient.post(request_url, nil, Authorization: authorization)
+    User.logout access_token
   end
 
   def signup(access_token, properties = {})
-    authorization = "Bearer #{access_token}"
-
-    query_params = {
-      properties: properties.to_json
-    }
-
-    request_url = 'https://kapi.kakao.com/v1/user/signup'
-    RestClient.post(request_url, query_params, Authorization: authorization)
+    User.signup access_token, properties
   end
 
   def unlink(access_token)
-    authorization = "Bearer #{access_token}"
-
-    request_url = 'https://kapi.kakao.com/v1/user/unlink'
-    RestClient.post(request_url, nil, Authorization: authorization)
+    User.unlink access_token
   end
 
   def me(access_token, property_keys = [], secure_resource = false)
-    authorization = "Bearer #{access_token}"
-
-    request_url = 'https://kapi.kakao.com/v1/user/me'
-    RestClient.post(request_url, nil, Authorization: authorization)
+    User.me access_token, property_keys, secure_resource
   end
 
   def update_profile(access_token, props = {})
-    authorization = "Bearer #{access_token}"
-    params = {
-      properties: props.to_json
-    }
-    request_url = 'https://kapi.kakao.com/v1/user/update_profile'
-    RestClient.post(request_url, params, Authorization: authorization)
+    User.update_profile access_token, props
   end
 
   def user_ids(limit = 100, from_id = 0, order = 'asc')
-    authorization = "KakaoAK #{admin_key}"
-    params = {}
-    params[:limit] = limit
-    params[:from_id] = from_id if from_id > 0
-    params[:order] = order
-
-    request_url = 'https://kapi.kakao.com/v1/user/ids'
-    RestClient.post(request_url, params, Authorization: authorization)
+    User.ids admin_key, limit, from_id, order
   end
 
   def access_token_info(access_token)
-    authorization = "Bearer #{access_token}"
-
-    request_url = 'https://kapi.kakao.com/v1/user/access_token_info'
-    RestClient.get(request_url, Authorization: authorization)
+    User.access_token_info access_token
   end
 
   def is_story_user?(access_token)
-    authorization = "Bearer #{access_token}"
-
-    request_url = 'https://kapi.kakao.com/v1/api/story/isstoryuser'
-    RestClient.get(request_url, Authorization: authorization)
+    Story.story_user? access_token
   end
 
   def story_profile(access_token, secure_resource = false)
-    authorization = "Bearer #{access_token}"
-
-    request_url = 'https://kapi.kakao.com/v1/api/story/profile'
-    RestClient.get(request_url, Authorization: authorization)
+    Story.story_profile access_token, secure_resource
   end
 
-  def story_write_post(access_token, type, required_params, options = {})
+  def story_post(access_token, type, required_params, options = {})
     required_params[:access_token] = access_token
 
     case type
-    when STORY_POST_TYPE_NOTE
-      story_write_note_post required_params, options
-    when STORY_POST_TYPE_IMAGE
+    when Story::POST_TYPE_NOTE
+      Story.post_note required_params, options
+    when Story::POST_TYPE_IMAGE
       file_paths = required_params[:image_url_list]
       required_params[:image_url_list] = upload_multi(access_token, file_paths)
-      story_write_photo_post required_params, options
-    when STORY_POST_TYPE_LINK
+      Story.post_photo required_params, options
+    when Story::POST_TYPE_LINK
       url = required_params[:url]
       required_params[:link_info] = link_info(access_token, url)
-      story_write_link_post required_params, options
+      Story.post_link required_params, options
     end
   end
 
   def my_story(access_token, story_id)
-    authorization = "Bearer #{access_token}"
-
-    request_url = "https://kapi.kakao.com/v1/api/story/mystory?id=#{story_id}"
-    RestClient.get(request_url, Authorization: authorization)
+    Story.my_story access_token, story_id
   end
 
   def my_stories(access_token, last_id)
-    authorization = "Bearer #{access_token}"
-
-    request_url = "https://kapi.kakao.com/v1/api/story/mystories?last_id=#{last_id}"
-    RestClient.get(request_url, Authorization: authorization)
+    Story.my_stories access_token, last_id
   end
 
   def delete_my_story(access_token, id)
-    authorization = "Bearer #{access_token}"
-
-    request_url = "https://kapi.kakao.com/v1/api/story/delete/mystory?id=#{id}"
-    RestClient.delete(request_url, Authorization: authorization)
-  end
-
-  def talk_profile(access_token, secure_resource=false)
-    authorization = "Bearer #{access_token}"
-
-    request_url = 'https://kapi.kakao.com/v1/api/talk/profile'
-    RestClient.get(request_url, Authorization: authorization)
+    Story.delete_my_story access_token, id
   end
 
-  def self.default_story_post_options
-    # TODO. add app schemes
-    {
-      permission: 'A',
-      enable_share: false,
-    }
+  def talk_profile(access_token, secure_resource = false)
+    Talk.talk_profile access_token, secure_resource
   end
 
   def upload_multi(access_token, file_paths)
-    authorization = "Bearer #{access_token}"
-    content_type = 'multipart/form-data; boundary=---------------------------012345678901234567890123456'
-
     files = []
     file_paths.each do |path|
       files << File.new(path, 'rb')
     end
 
-    params = {
-      file: files,
-      multipart: true
-    }
-    request_url = 'https://kapi.kakao.com/v1/api/story/upload/multi'
-    RestClient.post(request_url, params, Authorization: authorization, content_type: content_type)
+    Story.upload_multi access_token, files
   end
 
   def link_info(access_token, url)
-    authorization = "Bearer #{access_token}"
-
-    request_url = "https://kapi.kakao.com/v1/api/story/linkinfo?url=#{url}"
-    RestClient.get(request_url, Authorization: authorization)
-  end
-
-  private
-
-  def story_write_note_post(required_params, options)
-    content = required_params[:content]
-    access_token = required_params[:access_token]
-    authorization = "Bearer #{access_token}"
-
-    params = {}
-    params[:content] = content
-    params.merge!(options)
-
-    request_url = 'https://kapi.kakao.com/v1/api/story/post/note'
-    RestClient.post(request_url, params, Authorization: authorization)
-  end
-
-  def story_write_photo_post(required_params, options)
-    content = required_params[:content]
-    image_url_list = required_params[:image_url_list]
-    access_token = required_params[:access_token]
-    authorization = "Bearer #{access_token}"
-
-    params = {}
-    params[:content] = content || ''
-    params[:image_url_list] = image_url_list
-    params.merge!(options)
-
-    request_url = 'https://kapi.kakao.com/v1/api/story/post/photo'
-    RestClient.post(request_url, params, Authorization: authorization)
-  end
-
-  def story_write_link_post(required_params, options)
-    link_info = required_params[:link_info]
-    content = required_params[:content]
-    access_token = required_params[:access_token]
-    authorization = "Bearer #{access_token}"
-
-    params = {}
-    params[:content] = content || ''
-    params[:link_info] = link_info
-    params.merge!(options)
-
-    request_url = 'https://kapi.kakao.com/v1/api/story/post/link'
-    RestClient.post(request_url, params, Authorization: authorization)
+    Story.link_info access_token, url
   end
 end

data/lib/v1/api/story.rb

@@ -0,0 +1,113 @@
+class Story
+  POST_TYPE_NOTE = 0
+  POST_TYPE_IMAGE = 1
+  POST_TYPE_LINK = 2
+
+  HOST_KAUTH = 'https://kauth.kakao.com'.freeze
+  HOST_KAPI = 'https://kapi.kakao.com'.freeze
+
+  def self.story_user?(access_token)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/api/story/isstoryuser"
+    RestClient.get(request_url, Authorization: authorization)
+  end
+
+  def self.story_profile(access_token, secure_resource = false)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/api/story/profile"
+    request_url.concat('?secure_resource=true') if secure_resource
+    RestClient.get(request_url, Authorization: authorization)
+  end
+
+  def self.my_story(access_token, story_id)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/api/story/mystory?id=#{story_id}"
+    RestClient.get(request_url, Authorization: authorization)
+  end
+
+  def self.my_stories(access_token, last_id)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/api/story/mystories?last_id=#{last_id}"
+    RestClient.get(request_url, Authorization: authorization)
+  end
+
+  def self.delete_my_story(access_token, id)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/api/story/delete/mystory?id=#{id}"
+    RestClient.delete(request_url, Authorization: authorization)
+  end
+
+  def self.default_story_post_options
+    {
+      permission: 'A',
+      enable_share: false
+    }
+  end
+
+  def self.link_info(access_token, url)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/api/story/linkinfo?url=#{url}"
+    RestClient.get(request_url, Authorization: authorization)
+  end
+
+  def self.upload_multi(access_token, files)
+    authorization = "Bearer #{access_token}"
+    content_type = 'multipart/form-data; boundary=---------------------------012345678901234567890123456'
+
+    params = {
+      file: files,
+      multipart: true
+    }
+    request_url = "#{HOST_KAPI}/v1/api/story/upload/multi"
+    RestClient.post(request_url, params, Authorization: authorization, content_type: content_type)
+  end
+
+  def self.post_note(required_params, options)
+    content = required_params[:content]
+    access_token = required_params[:access_token]
+    authorization = "Bearer #{access_token}"
+
+    params = {}
+    params[:content] = content
+    params.merge!(options)
+
+    request_url = "#{HOST_KAPI}/v1/api/story/post/note"
+    RestClient.post(request_url, params, Authorization: authorization)
+  end
+
+  def self.post_photo(required_params, options)
+    content = options[:content]
+    image_url_list = required_params[:image_url_list]
+    access_token = required_params[:access_token]
+    authorization = "Bearer #{access_token}"
+
+    params = {}
+    params[:content] = content || ''
+    params[:image_url_list] = image_url_list
+    params.merge!(options)
+
+    request_url = "#{HOST_KAPI}/v1/api/story/post/photo"
+    RestClient.post(request_url, params, Authorization: authorization)
+  end
+
+  def self.post_link(required_params, options)
+    link_info = required_params[:link_info]
+    content = options[:content]
+    access_token = required_params[:access_token]
+    authorization = "Bearer #{access_token}"
+
+    params = {}
+    params[:content] = content || ''
+    params[:link_info] = link_info
+    params.merge!(options)
+
+    request_url = "#{HOST_KAPI}/v1/api/story/post/link"
+    RestClient.post(request_url, params, Authorization: authorization)
+  end
+end

data/lib/v1/api/talk.rb

@@ -0,0 +1,11 @@
+class Talk
+  HOST_KAUTH = 'https://kauth.kakao.com'.freeze
+  HOST_KAPI = 'https://kapi.kakao.com'.freeze
+
+  def self.talk_profile(access_token, secure_resource = false)
+    authorization = "Bearer #{access_token}"
+    request_url = "#{HOST_KAPI}/v1/api/talk/profile"
+    request_url.concat('&secure_resource=true') if secure_resource
+    RestClient.get(request_url, Authorization: authorization)
+  end
+end

data/lib/v1/user.rb

@@ -0,0 +1,71 @@
+class User
+  HOST_KAUTH = 'https://kauth.kakao.com'.freeze
+  HOST_KAPI = 'https://kapi.kakao.com'.freeze
+
+  def self.logout(access_token)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/user/logout"
+    RestClient.post(request_url, nil, Authorization: authorization)
+  end
+
+  def self.signup(access_token, properties = {})
+    authorization = "Bearer #{access_token}"
+
+    query_params = {
+      properties: properties.to_json
+    }
+
+    request_url = "#{HOST_KAPI}/v1/user/signup"
+    RestClient.post(request_url, query_params, Authorization: authorization)
+  end
+
+  def self.unlink(access_token)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/user/unlink"
+    RestClient.post(request_url, nil, Authorization: authorization)
+  end
+
+  def self.me(access_token, property_keys = [], secure_resource = false, user_id = 0)
+    authorization = "Bearer #{access_token}"
+    params = {
+      propertyKeys: property_keys,
+      secure_resource: secure_resource
+    }
+    if user_id > 0
+      params[:target_id_type] = 'user_id'
+      params[:target_id] = user_id
+    end
+
+    request_url = "#{HOST_KAPI}/v1/user/me"
+    RestClient.post(request_url, params, Authorization: authorization)
+  end
+
+  def self.update_profile(access_token, props = {})
+    authorization = "Bearer #{access_token}"
+    params = {
+      properties: props.to_json
+    }
+    request_url = "#{HOST_KAPI}/v1/user/update_profile"
+    RestClient.post(request_url, params, Authorization: authorization)
+  end
+
+  def self.ids(admin_key, limit = 100, from_id = 0, order = 'asc')
+    authorization = "KakaoAK #{admin_key}"
+    params = {}
+    params[:limit] = limit
+    params[:from_id] = from_id if from_id > 0
+    params[:order] = order
+
+    request_url = "#{HOST_KAPI}/v1/user/ids"
+    RestClient.post(request_url, params, Authorization: authorization)
+  end
+
+  def self.access_token_info(access_token)
+    authorization = "Bearer #{access_token}"
+
+    request_url = "#{HOST_KAPI}/v1/user/access_token_info"
+    RestClient.get(request_url, Authorization: authorization)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kakao-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Kyoungwon Lee
@@ -37,6 +37,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/kakao-rest-api.rb
+- lib/v1/api/story.rb
+- lib/v1/api/talk.rb
+- lib/v1/user.rb
 homepage: http://rubygems.org/gems/kakao-rest-api
 licenses:
 - MIT