hatenablog 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c7e933e59b738cfcda010915591ffe89e236651
-  data.tar.gz: 0947478b9a9a5e8d706f6d196d4755bbfd6988d3
+  metadata.gz: e3508c942b368912bd0f8e1138811baacae21e75
+  data.tar.gz: 4f7171f31d4fc98732538d4ff8efd6ebe35e65a8
 SHA512:
-  metadata.gz: a7715ef9b24771c3a73d4be1d93e9f8e873d909b0aa92442d7bbe4e706202c8b423287bbe479ba6ba899626f9fd75e11937a5c3ce33b1784bbd41a743ed7ad60
-  data.tar.gz: df97bcf0b81ec75e4ab068d09ce597eb273fa780f60fbbf1ee82568b4ae087c144a3c8a30024ba548b6b219a92edfc6dda365b71e2917a28f7906b0954ddbd2d
+  metadata.gz: 9bc1d22e6c16402eec2f778178d0bd3048586979037a6e18342f39572e6f89de915c530b4ab7e019dd57eaf9cc17dd5cf4cd1b1c08fac716f498ca0a8b531f29
+  data.tar.gz: 53f5a0c7ee0c419e358baf6a72dcfe5c09a7c77b6508a377515e2fcd6a9d60ec90d2a2dee123238cb1a5ef3b3e32316ad313e80728af5174ff1742769f28cfe4

data/.travis.yml

@@ -3,8 +3,11 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.2.0
+  - 2.3.0
 env:
   - TZ=Asia/Tokyo
 addons:
   code_climate:
     repo_token: 309cf0784d00d2a6009566d28be111a8a0280cdeb2da280225eedf577b16beb5
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -1,6 +1,9 @@
 source 'https://rubygems.org'
 
-gem "codeclimate-test-reporter", group: :test, require: nil
+group :test do
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+end
 
 # Specify your gem's dependencies in hatenablog.gemspec
 gemspec

data/README.md

@@ -4,8 +4,9 @@
 [![Code Climate](https://codeclimate.com/github/kymmt90/hatenablog/badges/gpa.svg)](https://codeclimate.com/github/kymmt90/hatenablog)
 [![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 or Basic authorization:
+> A library for Hatena Blog AtomPub API
+
+This gem supports following operations through OAuth 1.0a or Basic authentication:
 
 - Get blog feeds, entries and categories
 - Post blog entries
@@ -28,7 +29,7 @@ Or install it yourself as:
 
     $ gem install hatenablog
 
-### Get OAuth keys and tokens
+### Get OAuth credentials
 
 You need to set up OAuth 1.0a keys and tokens before using this gem.
 
@@ -46,7 +47,7 @@ Execute this command:
 	Access token: <your access token>
 	Access token secret: <your access token secret>
 
-#### 3. Set up the YAML configuration file
+#### 3. [Optional] Set up the YAML configuration file
 
 The default configuration file name is `config.yml`:
 
@@ -70,9 +71,13 @@ 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.
+`blog_id` means your Hatena Blog domain, like "example-user.hatenablog.com".
+
+You also can set these configurations in your code as described in [the below section](#factories).
+
+### [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 and set up `config.yml` like the following.
 
 ```yml
 auth_type: basic
@@ -108,3 +113,115 @@ Hatenablog::Client.create do |blog|
   blog.delete_entry(updated_entry.id)
 end
 ```
+
+## API
+
+### Factories
+
+You can create the client from the configuration file.
+
+```ruby
+# Create the client from "./config.yml"
+client = Hatenablog::Client.create
+
+# Create the client from the specified configuration
+client = Hatenablog::Client.create('../another_config.yml')
+
+Hatenablog::Client.create do |client|
+  # Use the client in the block
+end
+```
+
+You can also create the client with a block for configurations.
+
+```ruby
+client = Hatenablog::Client.new do |config|
+  config.consumer_key        = 'XXXXXXXXXXXXXXXXXXXX'
+  config.consumer_secret     = 'XXXXXXXXXXXXXXXXXXXX'
+  config.access_token        = 'XXXXXXXXXXXXXXXXXXXX'
+  config.access_token_secret = 'XXXXXXXXXXXXXXXXXXXX'
+  config.user_id             = 'example-user'
+  config.blog_id             = 'example-user.hatenablog.com'
+end
+```
+
+### Blog
+
+```ruby
+client.title        # Get the blog title
+client.author_name  # Get the blog author name
+```
+
+### Feeds
+
+```ruby
+feed = client.next_feed # Get the first feed when no argument is passed
+feed.uri
+feed.next_uri     # The next feed URI
+feed.title
+feed.author_name
+feed.update       # Updated datetime
+
+feed.entries  # entries in the feed
+feed.each_entry do |entry|
+  # ...
+end
+feed.has_next?  # true if the next page exists
+next_feed = client.next_feed(feed)
+```
+
+### Entries
+
+```ruby
+client.get_entry('0000000000000000000') # Get the entry specifed by its ID
+client.entries      # Get blog entries in the first page
+client.entries(1)   # Get blog entries in the first and the second page
+client.all_entries  # Get all entries in the blog
+
+entry = client.post_entry('Example Title',  # title
+                          'This is the **example** entry.',  # content
+                          ['Ruby', 'Rails'],  # categories
+                          'yes'  # draft
+                         )
+entry.id
+entry.uri
+entry.edit_uri
+entry.author_name
+entry.title        #=> 'Example Title'
+entry.content      #=> 'This is the **example** entry.'
+entry.draft        #=> 'yes'
+entry.draft?       #=> true
+entry.categories   #=> ['Ruby', 'Rails']
+entry.updated      # Updated datetime
+
+client.update_entry(entry.id,
+                    entry.title,
+                    'This is the **modified** example entry.',
+                    entry.categories,
+                    'no')
+client.delete_entry(entry.id)
+```
+
+### Categories
+
+```ruby
+categories = client.categories  # Get categories registered in the blog
+categories.each do |cat|
+  puts cat
+end
+
+# When categories are fixed, you can only use those categories for your entries.
+# ref: https://tools.ietf.org/html/rfc5023#section-7.2.1.1
+categories.fixed?
+```
+
+## Contributing
+
+1. Create your feature branch (`git checkout -b my-new-feature`)
+2. Commit your changes (`git commit -am 'Add some feature'`)
+3. Push to the branch (`git push origin my-new-feature`)
+4. Create a new Pull Request
+
+## License
+
+MIT

data/lib/hatenablog/client.rb

@@ -24,6 +24,16 @@ module Hatenablog
       yield blog
     end
 
+    def initialize(config = nil)
+      if block_given?
+        yield config = Configuration.new
+        config.check_valid_or_raise
+      end
+      @requester = Requester.create(config)
+      @user_id = config.user_id
+      @blog_id = config.blog_id
+    end
+
     # Get a blog title.
     # @return [String] blog title
     def title
@@ -38,20 +48,18 @@ module Hatenablog
       feed.author_name
     end
 
-    # Get blog entries array.
+    # Get a enumerator of blog entries.
     # @param [Fixnum] page page number to get
-    # @return [Array] blog entries
+    # @return [Hatenablog::Entries] enumerator of blog entries
     def entries(page = 0)
-      feed = Feed.load_xml(get_collection(collection_uri).body)
-      entries = feed.entries
-
-      (1..page).each do
-        feed = next_feed(feed)
-        break if feed.nil?
-        entries += feed.entries
-      end
+      raise ArgumentError.new('page must be non-negative') if page < 0
+      Entries.new(self, page)
+    end
 
-      entries
+    # Get all blog entries.
+    # @return [Hatenablog::Entries] enumerator of blog entries
+    def all_entries
+      Entries.new(self, nil)
     end
 
     # Get the next feed of the given feed.
@@ -166,15 +174,8 @@ module Hatenablog
       builder.to_xml
     end
 
-
     private
 
-    def initialize(config)
-      @requester = Requester.create(config)
-      @user_id = config.user_id
-      @blog_id = config.blog_id
-    end
-
     def get(uri)
       @requester.get(uri)
     end
@@ -202,4 +203,21 @@ module Hatenablog
       @requester.delete(uri)
     end
   end
+
+  class Entries
+    include Enumerable
+
+    def initialize(client, page = 0)
+      @client = client
+      @page = page
+    end
+
+    def each
+      current_page = 0
+      until (@page && current_page > @page) || !(feed = @client.next_feed(feed))
+        feed.entries.each { |entry| yield entry }
+        current_page += 1
+      end
+    end
+  end
 end

data/lib/hatenablog/configuration.rb

@@ -4,20 +4,31 @@ require 'ostruct'
 
 module Hatenablog
   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)
+    OAUTH_KEYS = %i(consumer_key consumer_secret access_token access_token_secret user_id blog_id)
+    BASIC_KEYS = %i(api_key user_id blog_id)
 
     # Create a new configuration.
     # @param [String] config_file configuration file path
     # @return [Hatenablog::Configuration]
     def self.create(config_file)
-      config = YAML.load(ERB.new(File.read(config_file)).result)
-      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}"
+      loaded_config = YAML.load(ERB.new(File.read(config_file)).result)
+      config = new(loaded_config)
+      config.check_valid_or_raise
+    end
+
+    def check_valid_or_raise
+      unless (lacking_keys = self.send(:lacking_keys)).empty?
+        raise ConfigurationError, "Following keys are not setup. #{lacking_keys.map(&:to_s)}"
       end
+      self
+    end
+
+    private
 
-      new(config)
+    def lacking_keys
+      required_keys = self['auth_type'] == 'basic' ? BASIC_KEYS : OAUTH_KEYS
+      config_keys   = to_h.keys
+      required_keys.select { |key| !config_keys.include?(key) }
     end
   end
 

data/lib/hatenablog/requester.rb

@@ -3,6 +3,9 @@ require 'oauth'
 
 module Hatenablog
   module Requester
+    ATOM_CONTENT_TYPE = 'application/atom+xml; type=entry'.freeze
+    DEFAULT_HEADER = { 'Content-Type' => ATOM_CONTENT_TYPE }
+
     class RequestError < StandardError; end
 
     def self.create(config)
@@ -25,12 +28,7 @@ module Hatenablog
       # @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
+        request(:get, uri)
       end
 
       # HTTP POST method
@@ -38,15 +36,8 @@ module Hatenablog
       # @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
+      def post(uri, body = '', headers = DEFAULT_HEADER)
+        request(:post, uri, body: body, headers: headers)
       end
 
       # HTTP PUT method
@@ -54,29 +45,26 @@ module Hatenablog
       # @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
+      def put(uri, body = '', headers = DEFAULT_HEADER)
+        request(:put, uri, 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 = { 'Content-Type' => 'application/atom+xml; type=entry' })
+      def delete(uri, headers = DEFAULT_HEADER)
+        request(:delete, uri, headers: headers)
+      end
+
+      private
+
+      def request(method, uri, body: nil, headers: nil)
         begin
-          response = @access_token.delete(uri, headers)
+          @access_token.send(method, *[uri, body, headers].compact)
         rescue => problem
-          raise RequestError, 'Fail to DELETE: ' + problem.to_s
+          raise RequestError, "Fail to #{method.upcase}: " + problem.to_s
         end
-        response
       end
     end
 
@@ -136,7 +124,7 @@ module Hatenablog
         req.basic_auth @user_id, @api_key
         if body
           req.body = body
-          req.content_type = 'application/atom+xml; type=entry'
+          req.content_type = ATOM_CONTENT_TYPE
         end
 
         http = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.port == 443)

data/lib/hatenablog/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hatenablog
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kohei Yamamoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2016-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler