site_watcher 0.0.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5767baf72233d2af5eec6adb9b2810e0b8e8bd6c
-  data.tar.gz: 77bfeb19efc58a3d42e993bef52ce38f9e8087a5
+SHA256:
+  metadata.gz: 3871bda59d433bb2e423b760919479b402714bcb2ac18ef0d2e6312f3e06a3ee
+  data.tar.gz: b154e6c67de541fe782cdf1583c335ddd30fbc92d98cdc8895d1541f397ac414
 SHA512:
-  metadata.gz: f2491e2466343d145acf42246243612d336392fd3850138e10135b183418a23ec9e8e5245be49ed259311808484dbdf675fe79bf80820c36f08cdcc5eb21d8d0
-  data.tar.gz: 282ee975b7b81731b4e06e3e42f7e3b10435a360d3181c92ea5ead7cf2859cb8a2d3dc3775dfa478a5186357ed9f44bc95ca7b827fd01e5e1a77219463352827
+  metadata.gz: 50a42cc608c857812f62578cac2f37eca9a7c2a8b1d3b73850c6a95a5ff75f1a940f71b856a069ccb4e93891906b097cc051bcd4b9284ced82beaa0b6e62437b
+  data.tar.gz: 5b2587837c2d4db18c2565c7818146ce7b70e83c2989a39197dde9f3e013456af86d721e3e71f58daf76f66af43b78b945a4ed9d9122ccc7886aa684b9b33049

data/README.md

@@ -34,6 +34,9 @@ SiteWatcher.watch(every: 2) do
 
   # JSON
   page("http://www.bestbuy.com/api/1.0/product/summaries?skus=7522006") do
+    # Continue watching this page even after fulfillment
+    remove_on_fulfillment false
+
     test do |json|
       # `json` is a hash of the parsed JSON body.
       expect(
@@ -44,7 +47,9 @@ SiteWatcher.watch(every: 2) do
 end
 ```
 
-This script will block until all expectations have been fulfilled.
+This script will block until all expectations have been fulfilled and removed. Using `remove_on_fulfillment false` will cause it to block indefinitely.
+
+See [integration specs](spec/integration/watch_spec.rb) for more up-to-date usage examples.
 
 ## Testing fulfillment
 

data/lib/site_watcher/version.rb

@@ -1,3 +1,3 @@
 class SiteWatcher
-  VERSION = "0.0.2"
+  VERSION = "1.3.0"
 end

data/lib/site_watcher.rb

@@ -1,27 +1,37 @@
 require "site_watcher/version"
 
 require "capybara"
-require "rspec/expectations"
-require "open-uri"
+require "http"
 require "json"
 require "logger"
+require "rspec/expectations"
 
 class SiteWatcher
   def self.watch(opts={}, &block)
-    trap(:SIGINT) { abort(?\n) }
-
     dsl = DSL::Top.new
     dsl.instance_eval(&block)
 
     delay = opts.fetch(:every, 5)
-    logger = opts.fetch(:logger, ::Logger.new($stderr))
-    new(dsl.__sw_pages, delay, logger).watch
+    logger = opts.fetch(:logger, ::Logger.new($stderr, level: :warn))
+    timeout = opts.fetch(:timeout, {connect: 3, read: 10})
+
+    new(
+      dsl.__sw_before_hooks,
+      dsl.__sw_pages,
+      dsl.__sw_after_hooks,
+      delay,
+      logger,
+      timeout,
+    ).watch
   end
 
-  def initialize(pages, delay, logger)
+  def initialize(before_hooks, pages, after_hooks, delay, logger, timeout)
+    @before_hooks = before_hooks
     @pages = pages
+    @after_hooks = after_hooks
     @delay = delay
     @logger = logger
+    @timeout = timeout
     @force = false
   end
 
@@ -35,8 +45,8 @@ class SiteWatcher
 
         @pages.each do |page|
           begin
-            page.__sw_run!(force)
-            @pages.delete(page)
+            page.__sw_run!(force, @logger, @timeout)
+            @pages.delete(page) if page.__sw_remove_on_fulfillment
           rescue ::RSpec::Expectations::ExpectationNotMetError
           rescue => e
             @logger.warn("Exception on #{page.__sw_url}: #{e.inspect}")
@@ -61,22 +71,35 @@ class SiteWatcher
       @force = true
     end
 
+    @before_hooks.each(&:call)
     yield
   ensure
     ::Signal.trap(:INT, "DEFAULT")
     ::Signal.trap(:USR1, "DEFAULT")
+
+    @after_hooks.each(&:call)
   end
 
   module DSL
     class Top
-      attr_reader :__sw_pages
+      attr_reader :__sw_pages, :__sw_before_hooks, :__sw_after_hooks
 
       def initialize
         @__sw_pages = []
+        @__sw_before_hooks = []
+        @__sw_after_hooks = []
+      end
+
+      def before(&block)
+        @__sw_before_hooks << block
       end
 
-      def page(url, &block)
-        page = Page.new(url)
+      def after(&block)
+        @__sw_after_hooks << block
+      end
+
+      def page(url, **opts, &block)
+        page = Page.new(url, **opts)
         page.instance_eval(&block)
         @__sw_pages << page
       end
@@ -84,11 +107,17 @@ class SiteWatcher
 
     class Page
       include ::RSpec::Matchers
-      attr_reader :__sw_url
+      attr_reader :__sw_url, :__sw_remove_on_fulfillment
 
-      def initialize(url)
+      def initialize(url, method: :get, headers: {}, **opts)
         @__sw_url = url
         @__sw_tests = []
+        @__sw_method = method
+        @__sw_headers = headers
+        @__sw_http_opts = opts
+        @__sw_fulfilled = nil
+        @__sw_fetch = nil
+        @__sw_remove_on_fulfillment = true
       end
 
       def test(&block)
@@ -99,24 +128,52 @@ class SiteWatcher
         @__sw_fulfilled = block
       end
 
-      def __sw_run!(force=false)
-        ::OpenURI.open_uri(@__sw_url) do |response|
-          case response.content_type
+      def fetch(&block)
+        @__sw_fetch = block
+      end
+
+      def headers(hash)
+        @__sw_headers = hash
+      end
+
+      def http_method(http_method)
+        @__sw_http_method = http_method
+      end
+
+      def body(body)
+        @__sw_body = body
+      end
+
+      def remove_on_fulfillment(bool)
+        @__sw_remove_on_fulfillment = !!bool
+      end
+
+      def __sw_run!(force, logger, timeout)
+        if @__sw_fetch
+          response = @__sw_fetch.call(@__sw_url)
+        else
+          response = ::HTTP
+            .use(logging: {logger: logger})
+            .timeout(timeout)
+            .headers(@__sw_headers)
+            .request(@__sw_method, @__sw_url, **@__sw_http_opts)
+
+          case response.content_type.mime_type
           when /json/i
-            page = ::JSON.parse(response.read)
+            response = ::JSON.parse(response.to_s)
           else
-            page = ::Capybara::Node::Simple.new(response.read)
-          end
-
-          begin
-            @__sw_tests.each { |test| test.call(page) }
-          rescue ::RSpec::Expectations::ExpectationNotMetError => err
-            __sw_fulfilled! if force
-            raise(err)
+            response = ::Capybara::Node::Simple.new(response.to_s)
           end
+        end
 
-          __sw_fulfilled!
+        begin
+          @__sw_tests.each { |test| test.call(response) }
+        rescue ::RSpec::Expectations::ExpectationNotMetError => err
+          __sw_fulfilled! if force
+          raise(err)
         end
+
+        __sw_fulfilled!
       end
 
       private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_watcher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Alex Genco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - alexgenco@gmail.com
@@ -110,10 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Periodically monitor a website
 test_files: []
-has_rdoc: