lita-meetup-finder 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a19e4f4c790665cd9c45ee2233390c10f09c17f627bd8d912bc736342bccaccc
-  data.tar.gz: 7c22995bf6bfd9b5891210858f7296d1bfbf66bec6e0466933748edf99430925
+  metadata.gz: 8a06ecdb93d4ff7cdd441333156abfc7c525b4521c07e005f26a87b88e77da4e
+  data.tar.gz: fe59db060aae6890560c1f462e7c0f791ade7039f30a3cd52d7aedbcb4d3aeac
 SHA512:
-  metadata.gz: d1b3039d36a33673cb4e16f0307af3a6510774625fca7ef634d34f8ea0caf2e44aa95097e0a2f59c7e1cf0c45384ff85f1a4e8af302294d7720ec483205f63eb
-  data.tar.gz: 8034ac0995f3fe16248a3f3c0b2c041f0dc6236f9e5fafe072637cceb44cd30e61b2ce38cc3b2b9ce98efa87d204f175bdf07c81fb6cad9cd70d568d89b05105
+  metadata.gz: 5345eb9b2bca45a974e076c9c25d6568791e2e32d503bf51a75b0e94de557a648c425ebed1f40304d342acb6ea81ce3521936acdf3ac36e258d8bde0a6064cd3
+  data.tar.gz: 902f34591d30b83832cc87bf5558fc2df98c8784f9d3c224d50c24dfcf5cfb94ea65c9b9745b0a0e36b4ed4b7584405178686cdda8749a631db4f5cbb73db75b

data/examples/001-runtime-env-var.sh

@@ -0,0 +1,6 @@
+$ env MEETUP_API_KEY='14ae7022223d49b6e5e673d3e29' MEETUP_ZIP='38117' lita
+Type "exit" or "quit" to end the session.
+Lita > lita find meetup python
+Memphis Python User Group >> Group: Memphis Technology User Groups
+ >> Mon Nov 19 18:30:00 2018
+ >> https://www.meetup.com/memphis-technology-user-groups/events/255343667/

data/examples/999-push-gem.session

@@ -0,0 +1,83 @@
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master →) git commit -m "Initial handler code"
+[master (root-commit) 228d789] Initial handler code
+ 11 files changed, 105 insertions(+)
+ create mode 100644 .gitignore
+ create mode 100644 Gemfile
+ create mode 100644 README.md
+ create mode 100644 Rakefile
+ create mode 100644 lib/lita-meetup-finder.rb
+ create mode 100644 lib/lita/handlers/meetup_finder.rb
+ create mode 100644 lita-meetup-finder.gemspec
+ create mode 100644 locales/en.yml
+ create mode 100644 spec/lita/handlers/meetup_finder_spec.rb
+ create mode 100644 spec/spec_helper.rb
+ create mode 100644 templates/.gitkeep
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master) rake release
+lita-meetup-finder 0.1.0 built to pkg/lita-meetup-finder-0.1.0.gem.
+Tagged v0.1.0.
+Untagging v0.1.0 due to error.
+rake aborted!
+Couldn't git push. `git push ' failed with the following output:
+
+fatal: No configured push destination.
+Either specify the URL from the command-line or configure a remote repository using
+
+    git remote add <name> <url>
+
+and then push using the remote name
+
+    git push <name>
+
+
+
+Tasks: TOP => release => release:source_control_push
+(See full trace by running task with --trace)
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master) 
+git remote add origin git@github.com:dpritchett/lita-meetup-finder.git
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master) git push -u origin master
+Counting objects: 21, done.
+Delta compression using up to 4 threads.
+Compressing objects: 100% (12/12), done.
+Writing objects: 100% (21/21), 2.46 KiB | 252.00 KiB/s, done.
+Total 21 (delta 0), reused 0 (delta 0)
+remote: 
+remote: Create a pull request for 'master' on GitHub by visiting:
+remote:      https://github.com/dpritchett/lita-meetup-finder/pull/new/master
+remote: 
+To github.com:dpritchett/lita-meetup-finder.git
+ * [new branch]      master -> master
+Branch 'master' set up to track remote branch 'master' from 'origin'.
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master=) rake release
+lita-meetup-finder 0.1.0 built to pkg/lita-meetup-finder-0.1.0.gem.
+Tagged v0.1.0.
+Pushed git commits and tags.
+rake aborted!
+Your rubygems.org credentials aren't set. Run `gem push` to set them.
+
+Tasks: TOP => release => release:rubygem_push
+(See full trace by running task with --trace)
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master=) gem push
+Enter your RubyGems.org credentials.
+Don't have an account yet? Create one at https://rubygems.org/sign_up
+   Email:   dpritchett@gmail.com
+Password:   
+
+HTTP Basic: Access denied.
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master=) gem push
+Enter your RubyGems.org credentials.
+Don't have an account yet? Create one at https://rubygems.org/sign_up
+   Email:   dpritchett@gmail.com
+Password:   
+
+Signed in.
+ERROR:  While executing gem ... (Gem::CommandLineError)
+    Please specify a gem name on the command line (e.g. gem build GEMNAME)
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master=) gem login
+ERROR:  While executing gem ... (Gem::CommandLineError)
+    Unknown command login
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master=) rake release
+lita-meetup-finder 0.1.0 built to pkg/lita-meetup-finder-0.1.0.gem.
+Tag v0.1.0 has already been created.
+Pushed lita-meetup-finder 0.1.0 to rubygems.org
+/m/w/U/d/D/d/B/c/lita-meetup-finder (master=) 
+

data/lib/lita-meetup-finder.rb

@@ -5,6 +5,7 @@ Lita.load_locales Dir[File.expand_path(
 )]
 
 require "lita/handlers/meetup_finder"
+require "lita/meetup_result"
 
 Lita::Handlers::MeetupFinder.template_root File.expand_path(
   File.join("..", "..", "templates"),

data/lib/lita/handlers/meetup_finder.rb

@@ -1,9 +1,86 @@
+# START:require
+# Load 3rd party meetup API client gem
+require 'meetup_client'
+# END:require
+
 module Lita
   module Handlers
     class MeetupFinder < Handler
-      # insert handler code here
+      # START:custom_error
+      MeetupApiError = Class.new(StandardError)
+      # END:custom_error
+
+      # START:config
+      # Set these in your bot's lita_config.rb or via environment
+      #   variable
+      config :meetup_api_key, default: ENV['MEETUP_API_KEY']
+      # note the 
+      config :meetup_zip, default: ENV['MEETUP_ZIP']
+      # END:config
+
+      # START:route
+      route(/^find meetup\s+(.+)$/i, :find_matching_meetup, command: true)
+      # END:route
+
+      # START:handle_user_input
+      def find_matching_meetup(message)
+        # extract search term from user input
+        search_term = message.matches.first
+        # pass search term to meetup query method
+        meetups = meetups_matching search_term
+
+        # handle two basic outcomes: no results, 1+ results
+        if meetups.none?
+          message.reply "Sorry, no matching meetups found."
+        else
+          message.reply meetups.first&.tagline
+        end
+      end
+      # END:handle_user_input
+
+      # START:build_api_client
+      def client
+        MeetupClient.configure do |meetup_config|
+          # sets meetup config using value from lita config
+          meetup_config.api_key = config.meetup_api_key
+        end
+
+        # store client rather than rebuilding on each call
+        @_client ||= MeetupApi.new 
+      end
+      # END:build_api_client
+
+      # START:perform_lookup
+      # query Meetup API for local meetups and return a
+      #   list of matching MeetupResult objects
+      def meetups_matching(search_text)
+        query = build_search(search_text)
+
+        begin
+          response = client.open_events(query)
+          results = response.fetch('results')
+        rescue StandardError
+          raise MeetupApiError.new(response)
+        end
+
+        # coerce an array of JSON-ish results into richer
+        #   MeetupResult objects
+        results.map { |r| MeetupResult.new(r) }
+      end
+      # END:perform_lookup
+
+      # START:build_search
+      def build_search(search_text)
+         {
+          zip: config.meetup_zip,
+          format: 'json',
+          page: '5',
+          text: search_text
+        }
+     end
+     # END:build_search
 
       Lita.register_handler(self)
     end
   end
-end
+end

data/lib/lita/meetup_result.rb

@@ -0,0 +1,37 @@
+module Lita
+    class MeetupResult
+        # START:init
+        def initialize(raw_result)
+            @raw_result = raw_result
+
+            @name = raw_result.fetch('name')
+            @url = raw_result.fetch('event_url')
+            @group_name = raw_result.fetch('group').fetch('name')
+        end
+        # END:init
+
+        # START:attrs
+        # expose instance variables as attribute getters
+        attr_reader :raw_result, :name, :url, :group_name
+        # END:attrs
+
+        # START:start_time
+        # Human readable start time for the event
+        #   Raw time:   1541941200000 
+        #   Human time: Sun Nov 11 07:00:00 2018
+        def start_time
+            # API results are in milliseconds since the unix epoch
+            epoch_msec = raw_result.fetch('time')
+            epoch_sec = epoch_msec / 1000
+
+            Time.at(epoch_sec).ctime
+        end
+        # END:start_time
+
+        # START:tagline
+        def tagline
+            "#{name} >> Group: #{group_name} >> #{start_time} >> #{url}"
+        end
+        # END:tagline
+    end
+end

data/lita-meetup-finder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-meetup-finder"
-  spec.version       = "0.1.0"
+  spec.version       = "1.0.0"
   spec.authors       = ["Daniel J. Pritchett"]
   spec.email         = ["dpritchett@gmail.com"]
   spec.description   = "Ask your Lita chatbot to find relevant meetups in your area"
@@ -15,11 +15,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "lita", ">= 4.7"
+  # START:client
   spec.add_runtime_dependency 'meetup_client', '~> 1.0'
+  # END:client
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rspec", ">= 3.0.0"
+  # START:webmock
+  spec.add_development_dependency 'webmock', '~> 3.3'
+  # END:webmock
 end

data/spec/fixtures/meetup_results.json

@@ -0,0 +1 @@
+{"results":[{"utc_offset":-21600000,"venue":{"zip":"38104","country":"us","localized_country_name":"USA","city":"Memphis","address_1":"2164 Young Ave","name":"Grivet Outdoors","lon":-89.990074,"id":25963887,"state":"tn","lat":35.119804,"repinned":true},"headcount":0,"distance":5.100682735443115,"visibility":"public","waitlist_count":0,"created":1539897150000,"fee":{"amount":50,"currency":"USD","label":"Price","accepts":"wepay","required":"1"},"maybe_rsvp_count":0,"description":"<p>This is a super convenient opportunity to explore an area you may not have been out to yet! Pinnacle Mountain is located about 2.5 hours from Memphis right outside of Little Rock, Arkansas. Grivet rents a van and provides all transportation. All you have to do is hop on the van and we take care of the rest!</p> <p>We’ll be doing the Base Trail and hitting the peak by going up the West Summit Trail and coming back down the East Summit Trail. Although it is only about 0.75 miles each way, you are climbing about 750 feet very quickly, up and over several boulder fields. You should expect to use your hands and knees for stability and to pull yourself up on some rocks. We’ll also aim to cover the Rocky Valley Trail and the East Quarry Trail – bringing our total mileage for the day to around 6 miles. Although this sounds short, remember how steep some of it is, so I’m rating this hike as moderate-strenuous difficulty. I want to stress how physical those boulder fields are to get up and over! It is a lot of fun and something different to challenge even experienced hikers. We’ll be meeting at the store at 7:00 AM for coffee and tasty breakfast treats, hiking from 10:00 - 4:00 and returning home around 6:30 PM. Please RSVP for this day trip if you’d like to join us.</p> <p>There are only a few spots on the van left. Please contact [masked] for more information or to lock up your spot.</p>","event_url":"https://www.meetup.com/MemphisOutdoors/events/255648544/","yes_rsvp_count":3,"duration":43200000,"name":"Grivet Outdoors:  Hiking Trip to Pinnacle Mountain ","id":"255648544","time":1541941200000,"updated":1540832649000,"group":{"join_mode":"open","created":1210106868000,"name":"Memphis Outdoor Adventures","group_lon":-89.94999694824219,"id":1138444,"urlname":"MemphisOutdoors","group_lat":35.11000061035156,"who":"Adventurers"},"status":"upcoming"},{"utc_offset":-21600000,"venue":{"zip":"38104","country":"us","localized_country_name":"USA","city":"Memphis","address_1":"2164 Young Ave","name":"Grivet Outdoors","lon":-89.990074,"id":25963887,"state":"tn","lat":35.119804,"repinned":true},"headcount":0,"distance":5.100682735443115,"visibility":"public","waitlist_count":0,"created":1539897057000,"maybe_rsvp_count":0,"description":"<p>This is a super convenient opportunity to explore an area you may not have been out to yet! Pinnacle Mountain is located about 2.3 hours from Memphis right outside of Little Rock, Arkansas. Grivet rents a van and provides all transportation. All you have to do is hop on the van and we take care of the rest!</p> <p>We’ll be doing the Base Trail and hitting the peak by going up the West Summit Trail and coming back down the East Summit Trail. Although it is only about 0.75 miles each way, you are climbing about 750 feet very quickly, up and over several boulder fields. You should expect to use your hands and knees for stability and to pull yourself up on some rocks. We’ll also aim to cover the Rocky Valley Trail and the East Quarry Trail – bringing our total mileage for the day to around 6 miles. Although this sounds short, remember how steep some of it is, so I’m rating this hike as moderate-strenuous difficulty. I want to stress how physical those boulder fields are to get up and over! It is a lot of fun and something different to challenge even experienced hikers. We’ll be meeting at the store at 7:00 AM for coffee and tasty breakfast treats, hiking from 10:00 - 4:00 and returning home around 6:30 PM. Please RSVP for this day trip if you’d like to join us.</p> <p>The cost for this hike is $49.95 and there are only a few spots on the van left. Please contact [masked] for more information or to lock up your spot.</p>","event_url":"https://www.meetup.com/MemphisOutdoors/events/255648524/","yes_rsvp_count":3,"duration":43200000,"name":"Grivet Outdoors:  Hiking Trip to Pinnacle Mountain ","id":"255648524","time":1541941200000,"updated":1540264031000,"group":{"join_mode":"open","created":1210106868000,"name":"Memphis Outdoor Adventures","group_lon":-89.94999694824219,"id":1138444,"urlname":"MemphisOutdoors","group_lat":35.11000061035156,"who":"Adventurers"},"status":"upcoming"}]}

data/spec/lita/handlers/meetup_finder_spec.rb

@@ -1,4 +1,63 @@
-require "spec_helper"
+require 'spec_helper'
+require 'pry'
 
 describe Lita::Handlers::MeetupFinder, lita_handler: true do
+    subject { described_class.new(robot) }
+
+    let(:test_api_key) { nil } ##'14ae7022223d49b6e5e673d3e29' }
+    let(:test_zip) { 38117 }
+
+    # Ask webmock to intercept any HTTP traffic to meetup API
+    #  and respond with stored data instead of live data
+    before { stub_meetup_calls! }
+
+    # force config values to things you can test against
+    before(:each) do
+        # you'll need your own test API key here
+        subject.config.meetup_api_key = test_api_key
+        subject.config.meetup_zip = test_zip
+    end
+
+    describe 'routes' do
+      # confirm three variations on what's brad eating each trigger a response
+      it { is_expected.to route("Lita find meetup climbing") }
+      it { is_expected.to_not route("Lita what’s for dinner?") }
+    end
+
+    describe ':build_search' do
+        let(:search_text) { 'climbers'}
+        let(:result) { subject.build_search search_text }
+
+        it "should return an array of Meetup search parameters" do
+            expected = {
+                zip: test_zip,
+                format: 'json',
+                page: '5',
+                text: search_text
+            }
+
+            expect(result).to eq expected
+        end
+    end
+
+  # START:response
+  # validate your basic HTML content fetching methods
+  describe ':meetup_search' do
+    let(:climbers) { subject.meetups_matching 'climbers' }
+
+    it "should find two results" do
+      expect(climbers.count).to eq(2)
+    end
+  end
+  # END:response
+
+  # START:meetup_find
+  # high-level "lita hears X and returns Y" end-to-end testing
+  describe ':meetup_find' do
+    it 'responds with a list of relevant meetups' do
+      send_message "Lita find meetup climbing"
+      expect(replies.last).to match(/\w+ >> http/i)
+    end
+  end
+  # END:meetup_find
 end

data/spec/lita/meetup_result_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'json'
+require 'pry'
+
+describe Lita::MeetupResult do
+  let(:raw_results) { JSON.load(json_fixture).fetch('results') }
+
+  it "has a fixture with 2 results" do
+    expect(raw_results.count).to eq 2
+  end
+
+  context "Result parsing" do
+    let(:parsed_results) { raw_results.map { |el| described_class.new el } }
+
+    it "can parse the fixture's JSON input as MeetupResult objects" do
+      expect(parsed_results.map(&:class).uniq).to eq [described_class]
+    end
+
+    context "accessor methods" do
+      let(:result) { parsed_results.first }
+
+      it 'parses group name' do
+        expect(result.group_name).to eq "Memphis Outdoor Adventures"
+      end
+
+      it 'parses event name' do
+        expect(result.name).to include 'Pinnacle Mountain'
+      end
+
+      it 'parses start time' do
+        expect(result.start_time).to include 'Sun Nov 11'
+      end
+
+      it 'parses url' do
+        expect(result.url.start_with? 'https://www.meetup.com/').to be_truthy
+      end
+
+      context 'human-friendly formatting' do
+        let(:tagline) { result.tagline }
+        fields = [:group_name, :name, :start_time, :url]
+
+        fields.each do |field|
+          it "tagline includes #{field}" do
+            expected = result.send(field)
+            expect(tagline.include? expected).to be_truthy
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,3 +4,23 @@ require "lita/rspec"
 # A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
 # was generated with Lita 4, the compatibility mode should be left disabled.
 Lita.version_3_compatibility_mode = false
+
+require 'webmock/rspec'
+
+# call me in a before block anywhere you're calling pastebin!
+#   This will save you from fairly low-overhead API limits.
+def stub_meetup_calls!
+    stub_request(:get, /api.meetup.com/).
+    with(
+      headers: {
+        'Accept'=>'*/*',
+        'Accept-Charset'=>'UTF-8',
+        'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+        'User-Agent'=>'Ruby'
+      }).
+    to_return(status: 200, body: json_fixture, headers: {})
+end
+
+def json_fixture
+  @_raw_json ||= open('./spec/fixtures/meetup_results.json')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-meetup-finder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel J. Pritchett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-04 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: Ask your Lita chatbot to find relevant meetups in your area
 email:
 - dpritchett@gmail.com
@@ -119,11 +133,16 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- examples/001-runtime-env-var.sh
+- examples/999-push-gem.session
 - lib/lita-meetup-finder.rb
 - lib/lita/handlers/meetup_finder.rb
+- lib/lita/meetup_result.rb
 - lita-meetup-finder.gemspec
 - locales/en.yml
+- spec/fixtures/meetup_results.json
 - spec/lita/handlers/meetup_finder_spec.rb
+- spec/lita/meetup_result_spec.rb
 - spec/spec_helper.rb
 - templates/.gitkeep
 homepage: https://github.com/dpritchett/lita-meetup-finder
@@ -152,5 +171,7 @@ signing_key:
 specification_version: 4
 summary: Help Lita query the Meetup.com API for local meetups
 test_files:
+- spec/fixtures/meetup_results.json
 - spec/lita/handlers/meetup_finder_spec.rb
+- spec/lita/meetup_result_spec.rb
 - spec/spec_helper.rb