webpage_update_checker 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46e6b17d245cd2498f15e9c90cf27a0fe7eab44a5225df8b2f85e2ba1d0b3168
-  data.tar.gz: e0ddec03ded73b0ff25fb501dd4ff109116312a8b6d8e755bf760fa7c944620c
+  metadata.gz: f8c2526d9cd437964c3c639911f5f67a47ac66864e6728ca16c5f3369b761bb0
+  data.tar.gz: 18acb4cde3a66373d7ddea4b1175d89b696ca52dc08be62e39a327f535dcdb79
 SHA512:
-  metadata.gz: c0bff916a00b5d212371a290815641d8157bec705f132a437f1c04a6a78fba26be6fe60395339b1d5dd018a8d8c97763db25a7b50aa1c05bd39c7f9f4df35ef1
-  data.tar.gz: f2b51da4b49bf233ab3c01b54fc2759d9222fc7706ab43974fef603abefdab023bca5f566ad6c6d026f5706989174a82321bac933a064fb2d86a11e68ab3b6ef
+  metadata.gz: 261c561477dce557e7ea8dcb849ef598040dafa37533dd5ec9a48a77c9ea9039b92adce9cc6cc18429fde9d1b567e8424be76556ad50a820d08209704bdd049b
+  data.tar.gz: eb0d9b21d0ec08687c1eb3b66944569ca01c146bbb26cab94352f5569195fd46c7fb037971078f79ce471d05bd5c0242553a3e619b962dc0b80ecf1c658d9c37

data/.gitignore

@@ -51,3 +51,4 @@ build-iPhoneSimulator/
 
 .rspec_status
 .vscode
+.history

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webpage_update_checker (1.2.0)
+    webpage_update_checker (1.3.0)
       mechanize
 
 GEM

data/README.md

@@ -7,11 +7,16 @@
 
 # Usage
 ```
-gem 'webpage_update_checker'
+$ vim Gemfile
+# Add a line
+# gem 'webpage_update_checker'
+$ bundle install
 ```
 
+or
+
 ```bash
-$ bundle install
+$ gem install webpage_update_checker
 ```
 
 ```ruby
@@ -20,9 +25,15 @@ require 'webpage_update_checker'
 checker = WebpageUpdateChecker::Client.new
 target_page_md5 = WebpageUpdateChecker::Methods::Md5.new(uri: 'http://www.ne.jp/asahi/pursuits/ootsuki/pc/X68k/x680x0.xhtml')
 
-checker.current_diff_value(target_page_md5) #=> fb2eeb524e6b5637ef7fa4bed48f1d67
-checker.updated?(target_page_md5, previous_diff_value: 'fb2eeb524e6b5637ef7fa4bed48f1d67') #=> false (not updated)
-checker.updated?(target_page_md5, previous_diff_value: '12345678901234567890123456789012') #=> true (updated)
+checker.current_comparison_value(target_page_md5) #=> fb2eeb524e6b5637ef7fa4bed48f1d67
+checker.updated?(target_page_md5, previous_comparison_value: 'fb2eeb524e6b5637ef7fa4bed48f1d67') #=> false (not updated)
+checker.updated?(target_page_md5, previous_comparison_value: '12345678901234567890123456789012') #=> true (updated)
+
+target_page_last_modified = WebpageUpdateChecker::Methods::LastModified.new(uri: 'http://www.ne.jp/asahi/pursuits/ootsuki/pc/X68k/x680x0.xhtml')
+checker.current_comparison_value(target_page_last_modified) #=> 2008-03-17 16:05:01 +0000
+
+target_page_http_status_code = WebpageUpdateChecker::Methods::HttpStatusCode.new(uri: 'http://www.ne.jp/asahi/pursuits/ootsuki/pc/X68k/x680x0.xhtml')
+checker.current_comparison_value(target_page_http_status_code) #=> 200
 ```
 
 # Methods
@@ -39,10 +50,15 @@ You can use these `Methods`.
 # methods
 You can use these methods in each `Methods`.
 
-- `#updated?(checked_object, previous_diff_value:)`
+- `#updated?(checked_object, previous_comparison_value:)`
     - `#=> true or false`
-- `#current_diff_value(checked_object)`
-    - `#=> object such as Time (LastModified) or String (MD5, SHA512...)`
+- `#current_comparison_value(checked_object)`
+    - `#=> object such as Time (LastModified), String (MD5, SHA512...) or Integer (HTTP status code)`
+
+# Note
+On v1.3.0, the method name that `current_diff_value` was changed to `current_comparison_value` and the keyword argument name that `previous_diff_value` was changed to `previous_comparison_value`.
+
+So please use `current_comparison_value` method and `previous_comparison_value` keyword argument becuase `current_diff_value` and `previous_diff_value` are deprecated now.
 
 # TODO
 - [Coveralls](https://coveralls.io/)

data/lib/webpage_update_checker/client.rb

@@ -3,12 +3,22 @@ Dir[File.expand_path('methods', __dir__) << '/*.rb'].each { |file| require file
 
 module WebpageUpdateChecker
   class Client
-    def updated?(checked_object, previous_diff_value:)
-      current_diff_value(checked_object) != previous_diff_value
+    def updated?(checked_object, previous_comparison_value: nil, previous_diff_value: nil)
+      if previous_comparison_value.nil?
+        # Deprecated keyword argument
+        current_comparison_value(checked_object) != previous_diff_value
+      else
+        current_comparison_value(checked_object) != previous_comparison_value
+      end
     end
 
+    def current_comparison_value(checked_object)
+      checked_object.current_comparison_value
+    end
+
+    # Depricated method
     def current_diff_value(checked_object)
-      checked_object.current_diff_value
+      current_comparison_value(checked_object)
     end
   end
 end

data/lib/webpage_update_checker/methods/http_status_code.rb

@@ -5,7 +5,7 @@ module WebpageUpdateChecker
         @uri = uri
       end
 
-      def current_diff_value
+      def current_comparison_value
         page = Mechanize.new.get(@uri)
         page.code.to_i
       rescue Mechanize::ResponseCodeError => e

data/lib/webpage_update_checker/methods/last_modified.rb

@@ -8,7 +8,7 @@ module WebpageUpdateChecker
         @uri = uri
       end
 
-      def current_diff_value
+      def current_comparison_value
         page = Mechanize.new.get(@uri)
         page.header['last-modified'] ? Time.parse(page.header['last-modified']) : nil
       end

data/lib/webpage_update_checker/methods/md5.rb

@@ -5,7 +5,7 @@ module WebpageUpdateChecker
         @uri = uri
       end
 
-      def current_diff_value
+      def current_comparison_value
         require 'digest/md5'
 
         page = Mechanize.new.get(@uri)

data/lib/webpage_update_checker/methods/sha1.rb

@@ -5,7 +5,7 @@ module WebpageUpdateChecker
         @uri = uri
       end
 
-      def current_diff_value
+      def current_comparison_value
         require 'digest/sha1'
 
         page = Mechanize.new.get(@uri)

data/lib/webpage_update_checker/methods/sha256.rb

@@ -5,7 +5,7 @@ module WebpageUpdateChecker
         @uri = uri
       end
 
-      def current_diff_value
+      def current_comparison_value
         require 'digest/sha2'
 
         page = Mechanize.new.get(@uri)

data/lib/webpage_update_checker/methods/sha384.rb

@@ -5,7 +5,7 @@ module WebpageUpdateChecker
         @uri = uri
       end
 
-      def current_diff_value
+      def current_comparison_value
         require 'digest/sha2'
 
         page = Mechanize.new.get(@uri)

data/lib/webpage_update_checker/methods/sha512.rb

@@ -5,7 +5,7 @@ module WebpageUpdateChecker
         @uri = uri
       end
 
-      def current_diff_value
+      def current_comparison_value
         require 'digest/sha2'
 
         page = Mechanize.new.get(@uri)

data/lib/webpage_update_checker/version.rb

@@ -1,3 +1,3 @@
 module WebpageUpdateChecker
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpage_update_checker
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Osamu Takiya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize