hatenablog 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1784b95efbc79289c1fcaefa30ae898223454a17
-  data.tar.gz: 0a57f752ea79980d82cd6fd4d11f020cabcfed24
+  metadata.gz: 6c7e933e59b738cfcda010915591ffe89e236651
+  data.tar.gz: 0947478b9a9a5e8d706f6d196d4755bbfd6988d3
 SHA512:
-  metadata.gz: 7a7e3181855b17a2aa47863c0279eb661f816bc242e90426feb3a67fde522d35c6c8674005be320e4932e1d7230a83255f79de0b899c9204196e9091e9b7d012
-  data.tar.gz: d2e5ba03fb472e2e2bae2628c9ea46f0c9a805105849ca10b2d56911235859fd829d1e0940feedf5203c8c86ae6a8760ab75c1878d020ee8cf82fc608705dc6b
+  metadata.gz: a7715ef9b24771c3a73d4be1d93e9f8e873d909b0aa92442d7bbe4e706202c8b423287bbe479ba6ba899626f9fd75e11937a5c3ce33b1784bbd41a743ed7ad60
+  data.tar.gz: df97bcf0b81ec75e4ab068d09ce597eb273fa780f60fbbf1ee82568b4ae087c144a3c8a30024ba548b6b219a92edfc6dda365b71e2917a28f7906b0954ddbd2d

data/README.md

@@ -5,7 +5,7 @@
 [![Test Coverage](https://codeclimate.com/github/kymmt90/hatenablog/badges/coverage.svg)](https://codeclimate.com/github/kymmt90/hatenablog/coverage)
 
 A library for Hatenablog AtomPub API.
-This gem supports following operations using OAuth authorization:
+This gem supports following operations using OAuth or Basic authorization:
 
 - Get blog feeds, entries and categories
 - Post blog entries
@@ -70,12 +70,23 @@ user_id: <%= ENV['USER_ID'] %>
 blog_id: <%= ENV['BLOG_ID'] %>
 ```
 
+### (OPTIONAL) Get Basic Authentication credentials
+If you want to use Basic Authentication, visit `http://blog.hatena.ne.jp/#{user_id}/#{blog_id}/config/detail`
+and check your API key (APIキー) and set up `config.yml` like the following.
+
+```yml
+auth_type: basic
+api_key: <%= ENV['API_KEY'] %>
+user_id: <%= ENV['USER_ID'] %>
+blog_id: <%= ENV['BLOG_ID'] %>
+```
+
 ## Usage
 
 ```ruby
 require 'hatenablog'
 
-# Read the OAuth configuration from 'config.yml'
+# Read the configuration from 'config.yml'
 Hatenablog::Client.create do |blog|
   # Get each entry's content
   blog.entries.each do |entry|

data/lib/hatenablog/client.rb

@@ -1,9 +1,8 @@
-require 'oauth'
-
 require 'hatenablog/category'
 require 'hatenablog/entry'
 require 'hatenablog/feed'
 require 'hatenablog/configuration'
+require 'hatenablog/requester'
 
 module Hatenablog
   class Client
@@ -13,16 +12,14 @@ module Hatenablog
     MEMBER_URI     = "https://blog.hatena.ne.jp/%s/%s/atom/entry/%s".freeze
     CATEGORY_URI   = "https://blog.hatena.ne.jp/%s/%s/atom/category".freeze
 
-    attr_writer :access_token
+    attr_writer :requester
 
     # Create a new hatenablog AtomPub client from a configuration file.
     # @param [String] config_file configuration file path
     # @return [Hatenablog::Client] created hatenablog client
     def self.create(config_file = DEFAULT_CONFIG_PATH)
-      config = Configuration.new(config_file)
-      blog = Hatenablog::Client.new(config.consumer_key, config.consumer_secret,
-                                    config.access_token, config.access_token_secret,
-                                    config.user_id, config.blog_id)
+      config = Configuration.create(config_file)
+      blog = Hatenablog::Client.new(config)
       return blog unless block_given?
       yield blog
     end
@@ -172,20 +169,14 @@ module Hatenablog
 
     private
 
-    def initialize(consumer_key, consumer_secret, access_token, access_token_secret,
-                   user_id, blog_id)
-      consumer = OAuth::Consumer.new(consumer_key, consumer_secret)
-      @access_token = OAuthAccessToken.new(OAuth::AccessToken.new(consumer,
-                                                                  access_token,
-                                                                  access_token_secret))
-
-      @user_id = user_id
-      @blog_id = blog_id
+    def initialize(config)
+      @requester = Requester.create(config)
+      @user_id = config.user_id
+      @blog_id = config.blog_id
     end
 
-
     def get(uri)
-      @access_token.get(uri)
+      @requester.get(uri)
     end
 
     def get_collection(uri = collection_uri)
@@ -200,84 +191,15 @@ module Hatenablog
     end
 
     def post(entry_xml, uri = collection_uri)
-      @access_token.post(uri, entry_xml)
+      @requester.post(uri, entry_xml)
     end
 
     def put(entry_xml, uri)
-      @access_token.put(uri, entry_xml)
+      @requester.put(uri, entry_xml)
     end
 
     def delete(uri)
-      @access_token.delete(uri)
+      @requester.delete(uri)
     end
   end
-
-  class OAuthAccessToken
-
-    # Create a new OAuth 1.0a access token.
-    # @param [OAuth::AccessToken] access_token access token object
-    def initialize(access_token)
-      @access_token = access_token
-    end
-
-    # HTTP GET method
-    # @param [string] uri target URI
-    # @return [Net::HTTPResponse] HTTP response
-    def get(uri)
-      begin
-        response = @access_token.get(uri)
-      rescue => problem
-        raise OAuthError, 'Fail to GET: ' + problem.to_s
-      end
-      response
-    end
-
-    # HTTP POST method
-    # @param [string] uri target URI
-    # @param [string] body HTTP request body
-    # @param [string] headers HTTP request headers
-    # @return [Net::HTTPResponse] HTTP response
-    def post(uri,
-             body = '',
-             headers = { 'Content-Type' => 'application/atom+xml; type=entry' } )
-      begin
-        response = @access_token.post(uri, body, headers)
-      rescue => problem
-        raise OAuthError, 'Fail to POST: ' + problem.to_s
-      end
-      response
-    end
-
-    # HTTP PUT method
-    # @param [string] uri target URI
-    # @param [string] body HTTP request body
-    # @param [string] headers HTTP request headers
-    # @return [Net::HTTPResponse] HTTP response
-    def put(uri,
-            body = '',
-            headers = { 'Content-Type' => 'application/atom+xml; type=entry' } )
-      begin
-        response = @access_token.put(uri, body, headers)
-      rescue => problem
-        raise OAuthError, 'Fail to PUT: ' + problem.to_s
-      end
-      response
-    end
-
-    # HTTP DELETE method
-    # @param [string] uri target URI
-    # @param [string] headers HTTP request headers
-    # @return [Net::HTTPResponse] HTTP response
-    def delete(uri,
-               headers = { 'Content-Type' => 'application/atom+xml; type=entry' })
-      begin
-        response = @access_token.delete(uri, headers)
-      rescue => problem
-        raise OAuthError, 'Fail to DELETE: ' + problem.to_s
-      end
-      response
-    end
-  end
-
-  class OAuthError < StandardError; end
 end

data/lib/hatenablog/configuration.rb

@@ -1,30 +1,23 @@
 require 'erb'
 require 'yaml'
+require 'ostruct'
 
 module Hatenablog
-  class Configuration
-    # For OAuth authorization.
-    attr_reader :consumer_key, :consumer_secret, :access_token, :access_token_secret
-
-    attr_reader :user_id, :blog_id
+  class Configuration < OpenStruct
+    OAUTH_KEYS = %w(consumer_key consumer_secret access_token access_token_secret user_id blog_id)
+    BASIC_KEYS = %w(api_key user_id blog_id)
 
     # Create a new configuration.
     # @param [String] config_file configuration file path
     # @return [Hatenablog::Configuration]
-    def initialize(config_file)
+    def self.create(config_file)
       config = YAML.load(ERB.new(File.read(config_file)).result)
-      unless config.has_key?('consumer_key') && config.has_key?('consumer_secret')     &&
-             config.has_key?('access_token') && config.has_key?('access_token_secret') &&
-             config.has_key?('user_id')      && config.has_key?('blog_id')
-        raise ConfigurationError, 'the configure file is incorrect'
+      keys = config['auth_type'] == 'basic' ? BASIC_KEYS : OAUTH_KEYS
+      unless (lacking_keys = keys.select {|key| !config.has_key? key}).empty?
+        raise ConfigurationError, "Following keys are not setup. #{lacking_keys}"
       end
 
-      @consumer_key        = config['consumer_key']
-      @consumer_secret     = config['consumer_secret']
-      @access_token        = config['access_token']
-      @access_token_secret = config['access_token_secret']
-      @user_id             = config['user_id']
-      @blog_id             = config['blog_id']
+      new(config)
     end
   end
 

data/lib/hatenablog/requester.rb

@@ -0,0 +1,149 @@
+require 'net/http'
+require 'oauth'
+
+module Hatenablog
+  module Requester
+    class RequestError < StandardError; end
+
+    def self.create(config)
+      if config.auth_type == 'basic'
+        Requester::Basic.new(config.user_id, config.api_key)
+      else
+        consumer = ::OAuth::Consumer.new(config.consumer_key, config.consumer_secret)
+        Requester::OAuth.new(::OAuth::AccessToken.new(consumer, config.access_token, config.access_token_secret))
+      end
+    end
+
+    class OAuth
+      # Create a new OAuth 1.0a access token.
+      # @param [OAuth::AccessToken] access_token access token object
+      def initialize(access_token)
+        @access_token = access_token
+      end
+
+      # HTTP GET method
+      # @param [string] uri target URI
+      # @return [Net::HTTPResponse] HTTP response
+      def get(uri)
+        begin
+          response = @access_token.get(uri)
+        rescue => problem
+          raise RequestError, 'Fail to GET: ' + problem.to_s
+        end
+        response
+      end
+
+      # HTTP POST method
+      # @param [string] uri target URI
+      # @param [string] body HTTP request body
+      # @param [string] headers HTTP request headers
+      # @return [Net::HTTPResponse] HTTP response
+      def post(uri,
+               body = '',
+               headers = { 'Content-Type' => 'application/atom+xml; type=entry' } )
+        begin
+          response = @access_token.post(uri, body, headers)
+        rescue => problem
+          raise RequestError, 'Fail to POST: ' + problem.to_s
+        end
+        response
+      end
+
+      # HTTP PUT method
+      # @param [string] uri target URI
+      # @param [string] body HTTP request body
+      # @param [string] headers HTTP request headers
+      # @return [Net::HTTPResponse] HTTP response
+      def put(uri,
+              body = '',
+              headers = { 'Content-Type' => 'application/atom+xml; type=entry' } )
+        begin
+          response = @access_token.put(uri, body, headers)
+        rescue => problem
+          raise RequestError, 'Fail to PUT: ' + problem.to_s
+        end
+        response
+      end
+
+      # HTTP DELETE method
+      # @param [string] uri target URI
+      # @param [string] headers HTTP request headers
+      # @return [Net::HTTPResponse] HTTP response
+      def delete(uri,
+                 headers = { 'Content-Type' => 'application/atom+xml; type=entry' })
+        begin
+          response = @access_token.delete(uri, headers)
+        rescue => problem
+          raise RequestError, 'Fail to DELETE: ' + problem.to_s
+        end
+        response
+      end
+    end
+
+    class Basic
+      METHODS = {
+        get: Net::HTTP::Get,
+        post: Net::HTTP::Post,
+        put: Net::HTTP::Put,
+        delete: Net::HTTP::Delete
+      }
+
+      # Create a new Basic authentication requester.
+      # @params [string] user_id Hatena user ID
+      # @params [string] api_key Hatena API key
+      def initialize(user_id, api_key)
+        @user_id = user_id
+        @api_key = api_key
+      end
+
+      # HTTP GET method
+      # @param [string] uri target URI
+      # @return [Net::HTTPResponse] HTTP response
+      def get(uri)
+        request(uri, :get)
+      end
+
+      # HTTP POST method
+      # @param [string] uri target URI
+      # @param [string] body HTTP request body
+      # @param [string] headers HTTP request headers
+      # @return [Net::HTTPResponse] HTTP response
+      def post(uri, body, headers = nil)
+        request(uri, :post, body: body, headers: headers)
+      end
+
+      # HTTP PUT method
+      # @param [string] uri target URI
+      # @param [string] body HTTP request body
+      # @param [string] headers HTTP request headers
+      # @return [Net::HTTPResponse] HTTP response
+      def put(uri, body, headers = nil )
+        request(uri, :put, body: body, headers: headers)
+      end
+
+      # HTTP DELETE method
+      # @param [string] uri target URI
+      # @param [string] headers HTTP request headers
+      # @return [Net::HTTPResponse] HTTP response
+      def delete(uri, headers = nil)
+        request(uri, :delete, headers: headers)
+      end
+
+      private
+      def request(uri, method, body: nil, headers: nil)
+        uri = URI(uri)
+        req = METHODS[method].new(uri, headers)
+        req.basic_auth @user_id, @api_key
+        if body
+          req.body = body
+          req.content_type = 'application/atom+xml; type=entry'
+        end
+
+        http = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.port == 443)
+        http.request(req)
+      rescue => problem
+        raise RequestError, "Fail to #{method.upcase}: " + problem.to_s
+      end
+    end
+  end
+end

data/lib/hatenablog/version.rb

@@ -1,3 +1,3 @@
 module Hatenablog
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hatenablog
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kohei Yamamoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-16 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,6 +146,7 @@ files:
 - lib/hatenablog/configuration.rb
 - lib/hatenablog/entry.rb
 - lib/hatenablog/feed.rb
+- lib/hatenablog/requester.rb
 - lib/hatenablog/version.rb
 homepage: https://github.com/kymmt90/hatenablog
 licenses: