movida_events 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 109b65c8a3086ee629865c0cb075fca0e24e2d9a231349b0710a44e1b5d3c0e6
+  data.tar.gz: 00ae815c08941d9b1ce1029e154142fdd984f030995b07822847d211aa20a285
+SHA512:
+  metadata.gz: af2b20d8b029cb46a42b67d84aea3ba490068275c54d0b94df874edc32f103c24c07f75a47666e1a9ddea856a92b85b7b118647bd81f6e60c59e49ec11747ffd
+  data.tar.gz: 6cb158eab1733d19697ea0049cadc2f83321d64d8d927edf41255f94d6991fa2d71b2c6d6ecd460908b7a8ece869799f0d81b1facde1388b184ea8ce6a35f87b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/Gemfile.lock
+/vendor/
+/coverage/
+/doc/
+/.yardoc/
+.byebug_history
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+---
+AllCops:
+  TargetRubyVersion: 2.3
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always

data/.travis.yml

@@ -0,0 +1,37 @@
+---
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+env:
+  global:
+    - COVERAGE=1
+    - secure: 'tpNa814wfnNKXEAN/mP70aPBkC0huXl3vPTjJh8QXBFG4Lf45TgLByv2YYM0fyP0ehILEyPcKUHb7KATUt/Sv+4HmQqzzlKxENTkvIi0kfIKoqbGqfUp5djfHNGpuuoaX1b861gXs7gGMKm902JmX53m5LfaMjZSLNWHOT/ATjfmOqMThxk82zaie/Ro27dZAAHfie2iyikesnNAY19GEJjiDvxuc2q3k2nOt5QVmzxQl1xK6SioiUhxyqoKQb0Jh5SHH+mKeHgU5jeHLY42IcW+iDajHG8yCM5BL2TWbB+d892vvN041fcKJ+vlyIHJoMVqkZ7J096s/xq+nWx+LsP/K6LzYiyfydVwla1HtALrz7FBMwGbj5futBfnnM0T9ZBPG7qthlZngg1s5irSQ8g0VuS8EHZp5h8Fwsksey0EH/x/RhfS4t4e3kviQIh5UZMac5jsNSNWpg8spOBrB0y/mZQtl++SL9ArzUqNogpVIqs03eLRzlacQWVlDWVmcMjtX0O2K3v00vOhkmKNyNXjMeWG7EED9bklPemOLNYifdfz4iCNonhoMLkUg9n6r3dWs9XRqM54Jk4vdshty2Gp3GAHHFnUuLoL/cnTJq90DnCHJa0qPs2KuW/I2j+INLqw6UOir/T1Oh8lMkD6EVBqY4Nj85pkufOmNT4Lv+Q='
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bin/rubocop
+  - bin/rspec --format doc
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+jobs:
+  include:
+    - stage: release
+      rvm: 2.3
+      script: skip
+      deploy:
+        provider: rubygems
+        api_key:
+          secure: 'tu+TzDHhiKVy5EeiMb8NVb/EHSflqhAhie6OFJc72nBBFAF9mow71sFpOzleQJ0gNdKnrWf17AQZLO9UQLIY2gP6fOHrLfDO5yLBMEpMjoqZISSBtugNUNCf8vg37QWbG6mAzMM67I/dMqT7U9KgL8CwaUwrs75W4KmIoaYqzkjiLc++k9j9dKpdbBBCEp0KNNbuAfEc9YWoas45LWFR1VfqB0CaGX4z8kWZai+N+8JLsmEO2bK6bPp2wtE+5ofXdkr5vSZK9Sp/7vLmh7P/D6ZDvuaF8KPt3wuPdtS1ZebuGWLsExcTTIgXzWBcYQ3hSHpvOwLWhI0M8ZpxmO3PPZO8+LsAzBijCj1HyOaXIrIybebuapvRixjWEV6mk3UXpBWgS3u0dslfbYa9hzbKCtAN/MTDSwLkdSuxsTuonNd406QQvX9O+yNT5+N8QpBqlAONeurSZhIRioiIyAwu6fL1CIJ5muDPaqG/V+dCh+z3W5KqnKgr9dY/bN8XizQoZhEFPg8WUjG2/ZRwtw3u5BD1rCbJIt3tAUSwhLLoSQFkH1f07evOuArOzaJjmehdaOiERkzsVmip65F/Bt+03NYShNzw3qK416ZjoxvVXpgb+mHVB8TEHL11bmvnrJ/v//fRp2W0ClHDZBmHvuem3UIXb7vnDDtvn8HClNHlgkg='
+        gem: movida_events
+        on:
+          tags: true
+          condition: bin/check-version
+      repo: machinima/movida_events

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+lib/**/*.rb
+-
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Warner Bros. Entertainment Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,181 @@
+# MovidaEvents
+
+[![Gem Version](https://badge.fury.io/rb/movida_events.svg)](https://badge.fury.io/rb/movida_events)
+[![Build Status](https://travis-ci.org/machinima/movida_events.svg?branch=master)](https://travis-ci.org/machinima/movida_events)
+[![Code Climate](https://codeclimate.com/github/machinima/movida_events/badges/gpa.svg)](https://codeclimate.com/github/machinima/movida_events)
+[![Test Coverage](https://codeclimate.com/github/machinima/movida_events/badges/coverage.svg)](https://codeclimate.com/github/machinima/movida_events)
+[![Inline docs](http://inch-ci.org/github/machinima/movida_events.svg?branch=master)](http://inch-ci.org/github/machinima/movida_events)
+
+A BeBanjo Movida event stream processor
+
+## Documentation
+
+Read below to get started, or see the [API Documentation][api-docs] for more
+details.
+
+[api-docs]: https://www.rubydoc.info/github/machinima/movida_events
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'movida_events'
+```
+
+## Usage
+
+```ruby
+require 'movida_events'
+
+client = MovidaEvents::Client.new(username: 'my_user', password: 'my_pass')
+poller = MovidaEvents::Poller.new(client)
+poller.poll do |event|
+  puts event.inspect
+end
+```
+
+Above, we first create a `Client` object. This serves as the interface between
+the poller and Movida. We then create a `Poller` object with that client. Then
+using the `poll` method, we print each event.
+
+By default, the Poller only processes events that occur after the poller has
+started.
+
+### Starting at after a given event
+
+Usually, you want to keep track of which event was processed last, so that you
+can ensure that every event gets processed. Use the `newer_than` option to tell
+the poller to process all events after a given ID.
+
+```ruby
+MovidaEvents::Poller.new(client, newer_than: 1234).poll do |event|
+  # All events after (but not including) event 1234 will be processed here
+end
+```
+
+### Filtering event types
+
+You can limit the types of events by setting the `event_types` option. See
+the [event type documentation][event-types] for a list of available types.
+
+```ruby
+types = ['title_created', 'title_updated']
+MovidaEvents::Poller.new(client, event_types: types).poll do |event|
+  # Only title_created and title_updated events will be processed here
+end
+```
+
+The `event_types` option also accepts a comma separated string like
+`"title_created,title_updated"`.
+
+[event-types]: https://github.com/bebanjo/almodovar/wiki/Movida-Events-Feed#event-type-event-type
+
+### The poll interval
+
+The poller checks for new events every few seconds. The default poll interval is
+30 seconds, that can be changed with the `interval` option.
+
+Note that even though the poller checks for new events every few seconds, the
+processing block will not get called unless there is a new event.
+
+```ruby
+# Polls every 5 seconds to check for new events
+MovidaEvents::Poller.new(client, interval: 5)
+```
+
+### Run code for every poll
+
+The processing block only gets called if an event is found, but we can use the
+`on_poll` method to set a callback for every time the poller checks for new
+events. This is especially useful for logging. It could be used to broadcast a
+heartbeat, etc.
+
+
+```ruby
+poller.on_poll do |stats|
+  log("Polled #{stats.requests} times")
+end
+poller.poll
+```
+
+See below for more information about the `stats` object.
+
+### Stats
+
+The blocks for `poll` and `on_poll` both accept a stats object. It contains
+information about the current poller status. The available methods are:
+
+- last: The ID of the event processed last. In the case of the `poll` method,
+  this is the current event ID.
+- requests: The number of requests processed including the current one.
+- events: The number of events processed including the current one.
+- request\_events: The number of events processed in the current request
+  including the current one. For `on_poll` this will always be 0.
+
+```ruby
+poller.poll do |event, stats|
+  log("Processing event number #{stats.events}")
+end
+```
+
+### Stopping the poller
+
+Use the `stop` method on the poller to manually stop polling for events. When
+`stop` is called, the poller will finish processing the current request
+including the associated events. Then it will exit the poll loop.
+
+```ruby
+trap('INT') { poller.stop }
+poller.poll do |event, stats|
+  # If the poller is interrupted in the middle of an event, it will finish
+  # processing before stopping
+  log('Processing event')
+end
+
+### Setting the number of times to poll
+
+The `poll` method accepts an argument `times` that sets how many times it checks
+for new events. This can be useful for testing.
+
+```ruby
+# Will only check for new events once
+MovidaEvents::Poller.new(client).poll(1) do |event|
+end
+```
+
+### Setting the API domain
+
+The default API domain is `movida.bebanjo.net`. It can be set to a different
+domain with the `domain` option in the client object.
+
+```ruby
+MovidaEvents::Client.new(
+  username: 'my_user',
+  password: 'my_pass',
+  domain: 'staging-movida.bebanjo.net'
+)
+```
+
+## Development
+
+You can run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+Before committing, run `bin/rake` to run the linter and tests.
+
+## License
+
+Copyright 2018 Warner Bros. Entertainment Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+YARD::Rake::YardocTask.new
+
+task default: :check
+task check: %i[rubocop spec]

data/bin/check-version

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+
+tag="$(git describe --abbrev=0)"
+tag="${tag#v}"
+gt=$(ruby -r ./lib/movida_events/version -e "puts Gem::Version.new(MovidaEvents::VERSION) >= Gem::Version.new('${tag}')")
+test "$gt" = true

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'movida_events'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/rake

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/yard

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/bin/yri

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/lib/movida_events.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# A BeBanjo Movida event stream processor
+module MovidaEvents
+end
+
+require 'almodovar'
+require 'movida_events/version'
+require 'movida_events/client'
+require 'movida_events/poller'
+require 'movida_events/stats'

data/lib/movida_events/client.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MovidaEvents
+  # The interface to the Movida event stream API
+  #
+  # Manages authentication and API configuration
+  class Client
+    # Create a new `MovidaEvents::Client`
+    #
+    # @param [Hash] options API setup options
+    # @option options [String] :username The username to authenticate with
+    #   Required.
+    # @option options [String] :password The password to authenticate with.
+    #   Required.
+    # @option options [String] :domain The API domain to use. Default:
+    #   'movida.bebanjo.net'.
+    def initialize(options = {})
+      @options = default_options.merge(options)
+      @auth = Almodovar::DigestAuth.new(
+        @options[:realm],
+        @options[:username],
+        @options[:password]
+      )
+    end
+
+    # Request a list of events
+    #
+    # @param [Hash] params Request parameters
+    # @option params [String] newer_than An event ID indicating the position in
+    #   the event stream where the request starts.
+    # @option params [String] event_type A comma separated list of event types.
+    # @yield Each returned event
+    # @yieldparam event [Almodovar::Resource] The event object
+    # @return [Enumerator<Almodovar::Resource>] An enumerator over the returned
+    #   events
+    def events(params = {}, &block)
+      Enumerator.new do |yielder|
+        events = events_collection(params)
+        events.each { |e| yielder << e }
+      end.each(&block)
+    end
+
+    private
+
+    # Get a `Almodovar::ResourceCollection` of events
+    #
+    # @param [Hash] params Request parameters, see {#events}.
+    def events_collection(params)
+      Almodovar::ResourceCollection.new(
+        api_url,
+        @auth,
+        nil,
+        params
+      )
+    end
+
+    # Get the events API URL
+    def api_url
+      "https://#{@options[:domain]}/api/events"
+    end
+
+    # Get the default options for {#initialize}
+    def default_options
+      {
+        realm: 'realm',
+        username: nil,
+        password: nil,
+        domain: 'movida.bebanjo.net'
+      }
+    end
+  end
+end

data/lib/movida_events/poller.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module MovidaEvents
+  # Polls for events and calls a method for each one
+  class Poller
+    # Indicates if the stop method has been called.
+    #
+    # @see #stop
+    # @return [Boolean] True if the poller is stopped
+    attr_reader :stopped
+
+    # Create a new `MovidaEvents::Poller` object
+    #
+    # @param client [Client] The client for making API requests
+    # @param options [Hash] Configuration options
+    # @option options [Integer] :newer_than Requests events that occur
+    #   only after the given ID
+    # @option options [String,Array<String>] :event_type Filter by only the
+    #   given event types
+    def initialize(client, options = {})
+      @client = client
+      @options = default_options.merge(options)
+      @stopped = false
+    end
+
+    # Set a callback to run whenever an API request is made
+    #
+    # Only one callback may be set
+    #
+    # @yield Every time a poll request is made
+    # @yieldparam stats [Stats] The current stats
+    def on_poll(&block)
+      @on_poll = block
+    end
+
+    # Poll for events
+    #
+    # This method continues infinitely unless `times` is set.
+    #
+    # @param times [Integer,nil] If set, polling stops after `times` requests.
+    # @yield Every new event
+    # @yieldparam event [Almodovar::Resource] The event object
+    # @yieldparam stats [Stats] The current stats
+    def poll(times = nil)
+      stats = initial_stats
+      repeat(times) do
+        before_request(stats)
+        @client.events(request_params(stats)) do |event|
+          stats.receive_event(event)
+          yield event, stats.clone if block_given?
+        end
+        break if @stopped
+
+        sleep @options[:interval] if stats.request_events.zero?
+      end
+    end
+
+    # Stop the poller
+    #
+    # When this is called, the poller will finish processing the current request
+    # and any associated events before stopping.
+    def stop
+      @stopped = true
+    end
+
+    private
+
+    # Repeat times or forever
+    #
+    # @param times [Integer,nil] The number of times to repeat, or nil for
+    #   infinite
+    # @yield `times` times or forever
+    def repeat(times)
+      times ? times.times { yield } : loop { yield }
+    end
+
+    # Builds the params for events requests
+    #
+    # The last event from stats determines where to start for the next API
+    # request
+    #
+    # @param stats [Stats] The current stats
+    # @return [Hash] The request params
+    def request_params(stats)
+      {
+        newer_than: stats.last,
+        event_type: event_types
+      }
+    end
+
+    # Builds the event types parameter
+    #
+    # Converts the `event_types` option into a string
+    # @return [String] The stringified events param
+    def event_types
+      types = @options[:event_types]
+      types.is_a?(Array) ? types.join(',') : types
+    end
+
+    # Before each request, updates stats and calls `on_poll`.
+    #
+    # @param stats [Stats] The current stats
+    def before_request(stats)
+      stats.start_request
+      @on_poll&.call(stats.clone)
+    end
+
+    # Sets up the initial stats state before polling
+    #
+    # If `newer_than` is not set, gets the latest event ID
+    #
+    # @return [Stats] The initial stats
+    def initial_stats
+      Stats.new(@options[:newer_than] || latest_id)
+    end
+
+    # Get the most recent event ID from the API
+    #
+    # The default behavior of the events API if given no parameters is to
+    # return the last 50 events. So we select the last event from those.
+    #
+    # @return [Integer] The most recent event ID
+    def latest_id
+      @client.events.to_a.last.id
+    end
+
+    # Get the default poller options
+    #
+    # @return [Hash] The default options
+    def default_options
+      {
+        newer_than: nil,
+        interval: 30
+      }
+    end
+  end
+end

data/lib/movida_events/stats.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module MovidaEvents
+  # Tracks polling stats
+  class Stats
+    # The last-processed event ID
+    #
+    # `nil` if no events have been processed
+    #
+    # @return [Integer,nil] The event ID
+    attr_reader :last
+
+    # The number of requests made to the API
+    #
+    # @return [Integer] The request count
+    attr_reader :requests
+
+    # The number of events processed
+    #
+    # @return [Integer] The event count
+    attr_reader :events
+
+    # The number of events processed in the current request
+    #
+    # @return [Integer] The request event count
+    attr_reader :request_events
+
+    # Create a new `MovidaEvents::Stats` object
+    #
+    # @param last [Integer,nil] The last-processed event ID.
+    def initialize(last = nil)
+      @last = last
+      @requests = 0
+      @events = 0
+      @request_events = 0
+    end
+
+    # Update stats when an event is received
+    #
+    # @param event [Almodovar::Resource] The event received
+    def receive_event(event)
+      @last = event.id
+      @events += 1
+      @request_events += 1
+    end
+
+    # Update stats when a new request is started
+    def start_request
+      @requests += 1
+      @request_events = 0
+    end
+  end
+end

data/lib/movida_events/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MovidaEvents
+  # The current gem version
+  VERSION = '1.0.0'
+end

data/movida_events.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'movida_events/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'movida_events'
+  spec.version = MovidaEvents::VERSION
+  spec.authors = ['Justin Howard']
+  spec.email = ['jmhoward0@gmail.com']
+  spec.license = 'Apache-2.0'
+
+  spec.summary = 'A BeBanjo Movida event stream processor'
+  spec.homepage = 'https://github.com/machinima/movida_events'
+
+  spec.files = `git ls-files -z`
+    .split("\x0")
+    .reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_dependency 'almodovar', '~> 1.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.61'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'yard', '~> 0.9.11'
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: movida_events
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: almodovar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: 
+email:
+- jmhoward0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check-version
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/yard
+- bin/yardoc
+- bin/yri
+- lib/movida_events.rb
+- lib/movida_events/client.rb
+- lib/movida_events/poller.rb
+- lib/movida_events/stats.rb
+- lib/movida_events/version.rb
+- movida_events.gemspec
+homepage: https://github.com/machinima/movida_events
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A BeBanjo Movida event stream processor
+test_files: []