turbovax 0.0.2pre

data/lib/turbovax/portal.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Turbovax
+  # Captures configuration required to fetch and process data from a specific vaccine website
+  class Portal
+    class << self
+      # @!macro [attach] definte_parameter
+      #   @method $1
+      #   $3
+      #   @return [$2]
+      #   @example $4
+      #     $5
+      def self.definte_parameter(
+        attribute, _doc_return_type, _explanation = nil, _explanation = nil,
+        _example = nil
+      )
+        # metaprogramming magic so that
+        #   1) attributes can be defined via DSL
+        #   2) attributes can be fetched when method is called without any parameters
+        #   3) attributes can saved static variables or blocks that can be called (for dynamic)
+        # might be better to refactor in the future
+        define_method attribute do |argument = nil, &block|
+          variable = nil
+          block_exists =
+            begin
+              variable = instance_variable_get("@#{attribute}")
+              variable.is_a?(Proc)
+            rescue StandardError
+              false
+            end
+
+          if !variable.nil?
+            block_exists ? variable.call(argument) : variable
+          else
+            instance_variable_set("@#{attribute}", argument || block)
+          end
+        end
+      end
+
+      definte_parameter :name, String, "Full name of portal", "Name",
+                        "'New York City Vaccine Website'"
+      definte_parameter :key, String, "Unique identifier for portal", "Key", "'nyc_vax'"
+      definte_parameter :public_url,
+                        String,
+                        "Link to public facing website", "Full URL",
+                        "'https://www.turbovax.info/'"
+
+      definte_parameter :request_headers, Hash, "Key:value mapping of HTTP request headers",
+                        "Specify user agent and cookies", "{ 'user-agent': 'Mozilla/5.0', " \
+                        "'cookies': 'ABC' }"
+      definte_parameter :request_http_method, Symbol,
+                        "Turbovax::Constants::GET_REQUEST_METHOD or " \
+                        "Turbovax::Constants::POST_REQUEST_METHOD"
+      definte_parameter :api_url, String, "Full API URL", "Example Turbovax endpoint",
+                        "'https://api.turbovax.info/v1/dashboard'"
+      definte_parameter :api_url_variables, Hash,
+                        "Hash or block that is interpolated ",
+                        '
+          api_url_variables do |extra_params|
+            {
+              site_id: NAME_TO_ID_MAPPING[extra_params[:name]],
+              date: extra_params.strftime("%F"),
+            }
+          end
+
+          #  before api_url_variables interpolation
+          api_url "https://api.turbovax.info/v1/sites/%{site_id}/%{date}"
+
+          #  after api_url_variables interpolation
+          api_url "https://api.turbovax.info/v1/sites/8888/2021-08-08"
+        '
+      # definte_parameter :request_body, Hash,
+      #                   "Hash (or block evaluates to a hash) that is used to in a POST request",
+      #                   '
+      #     request_body do |extra_params|
+      #       {
+      #         site_id: NAME_TO_ID_MAPPING[extra_params[:name]],
+      #         date: extra_params.strftime("%F"),
+      #       }
+      #     end
+      #   '
+
+      # Block that will called after raw data is fetched from API. Must return list of Location
+      # instances
+      # @param [Array] args passed from [Turbovax::DataFetcher]
+      # @param [Block] block stored as a class instance variable
+      # @return [Array<Turbovax::Location>]
+      # @example Parse API responses from turbovax.info
+      #     parse_response do |response|
+      #       response_json = JSON.parse(response)
+      #       response_json["locations"].map do |location|
+      #         Turbovax::Location.new(
+      #           name: location["name"],
+      #           time_zone: "America/New_York",
+      #           data: {
+      #             is_available: location["is_available"],
+      #             appointment_count: location["appointments"]["count"],
+      #             appointments: [{
+      #               time: "2021-04-19T17:21:15-04:00",
+      #             }]
+      #           }
+      #         )
+      #       end
+      #     end
+      def parse_response(*args, &block)
+        if args.size.positive? && !@parse_response.nil?
+          @parse_response.call(*args)
+        elsif !block.nil?
+          @parse_response = block
+        else
+          {}
+        end
+      end
+
+      # Block that will be executed and then appended to API url path. The extra_params variable is
+      # provided by Turbovax::DataFetcher.
+      # When specified, this will overwrite any query string that is already present in api_url
+      #
+      # @param [Array] args passed from [Turbovax::DataFetcher]
+      # @param [Block] block stored as a class instance variable
+      # @return [Hash]
+      # @example Append date and noCache to URL
+      #   # result: /path?date=2021-08-08&noCache=0.123
+      #   api_query_params do |extra_params|
+      #     {
+      #       date: extra_params[:date].strftime("%F"),
+      #       noCache: rand,
+      #     }
+      #   end
+      def api_query_params(*args, &block)
+        if args.size.positive? && !@api_query_params.nil?
+          @api_query_params.call(*args)
+        elsif !block.nil?
+          @api_query_params = block
+        else
+          {}
+        end
+      end
+
+      def request_body(*args, &block)
+        if args.size.positive? && !@request_body.nil?
+          @request_body.call(*args)
+        elsif !block.nil?
+          @request_body = block
+        else
+          {}.to_json
+        end
+      end
+
+      # Returns base API URL (used when creating Faraday connection)
+      def api_base_url
+        "#{api_uri_object.scheme}://#{api_uri_object.hostname}"
+      end
+
+      # Returns API URL path (used when making Faraday requests)
+      def api_path
+        "#{api_uri_object.path}?#{api_uri_object.query}"
+      end
+
+      # Calls parse_response and assigns portal to each location so user doesn't need to do
+      # this by themselves
+      def parse_response_with_portal(response, extra_params)
+        parse_response(response, extra_params).map do |location|
+          location.portal ||= self
+          location
+        end
+      end
+
+      private
+
+      def api_uri_object
+        @api_uri_object ||= URI(api_url % api_url_variables)
+      end
+    end
+  end
+end

data/lib/turbovax/twitter_client.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "twitter"
+
+module Turbovax
+  # Helper class that wraps around Twitter gem
+  class TwitterClient
+    def self.client
+      @client ||= Twitter::REST::Client.new do |config|
+        config.consumer_key        = Turbovax.twitter_credentials[:consumer_key]
+        config.consumer_secret     = Turbovax.twitter_credentials[:consumer_secret]
+        config.access_token        = Turbovax.twitter_credentials[:access_token]
+        config.access_token_secret = Turbovax.twitter_credentials[:access_token_secret]
+      end
+    end
+
+    def self.send_tweet(message, reply_to_id: nil)
+      response = client.update(message, in_reply_to_status_id: reply_to_id)
+      Turbovax.logger.info("[Turbovax::Twitter::Client] send_tweet (#{response.id})")
+      response
+    end
+  end
+end

data/lib/turbovax/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Turbovax
+  VERSION = "0.0.2pre"
+end

data/lib/turbovax.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "logger"
+
+require_relative "turbovax/constants"
+require_relative "turbovax/version"
+require_relative "turbovax/portal"
+require_relative "turbovax/location"
+require_relative "turbovax/appointment"
+require_relative "turbovax/data_fetcher"
+
+require_relative "turbovax/twitter_client"
+require_relative "turbovax/handlers/location_handler"
+
+# Turbovax gem
+module Turbovax
+  class InvalidRequestTypeError < StandardError; end
+
+  def self.configure
+    yield self
+  end
+
+  def self.logger
+    @logger ||= Logger.new($stdout, level: Logger::INFO)
+  end
+
+  def self.logger=(logger)
+    if logger.nil?
+      self.logger.level = Logger::FATAL
+      return self.logger
+    end
+
+    @logger = logger
+  end
+
+  def self.twitter_enabled
+    # enable twitter by default
+    @twitter_enabled = true if @twitter_enabled.nil?
+    @twitter_enabled
+  end
+
+  def self.twitter_enabled=(twitter_enabled)
+    @twitter_enabled = twitter_enabled
+  end
+
+  def self.twitter_credentials
+    raise NotImplementedError, "no twitter credentials provided" if @twitter_credentials.nil?
+
+    @twitter_credentials
+  end
+
+  def self.twitter_credentials=(twitter_credentials)
+    @twitter_credentials = twitter_credentials
+  end
+
+  def self.faraday_logging_config
+    @faraday_logging_config ||= { headers: false, bodies: false, log_level: :info }
+  end
+
+  def self.faraday_logging_config=(faraday_logging_config)
+    @faraday_logging_config = faraday_logging_config
+  end
+end

data/turbovax.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/turbovax/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "turbovax"
+  spec.version       = Turbovax::VERSION
+  spec.authors       = ["Huge Ma"]
+  spec.email         = ["huge@turbovax.info"]
+  spec.license       = "AGPLv3"
+
+  spec.summary       = "Quickly build vaccine twitter bots"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/hugem/turbovax-gem"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hugem/turbovax-gem"
+  spec.metadata["changelog_uri"] = "https://github.com/hugem/turbovax-gem/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 6.0", ">= 6.0.0.1"
+  spec.add_dependency "faraday", "~> 0.17"
+  spec.add_dependency "twitter", "~> 7.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: turbovax
+version: !ruby/object:Gem::Version
+  version: 0.0.2pre
+platform: ruby
+authors:
+- Huge Ma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Quickly build vaccine twitter bots
+email:
+- huge@turbovax.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/turbovax.rb
+- lib/turbovax/appointment.rb
+- lib/turbovax/constants.rb
+- lib/turbovax/data_fetcher.rb
+- lib/turbovax/handlers/location_handler.rb
+- lib/turbovax/location.rb
+- lib/turbovax/portal.rb
+- lib/turbovax/twitter_client.rb
+- lib/turbovax/version.rb
+- turbovax.gemspec
+homepage: https://github.com/hugem/turbovax-gem
+licenses:
+- AGPLv3
+metadata:
+  homepage_uri: https://github.com/hugem/turbovax-gem
+  source_code_uri: https://github.com/hugem/turbovax-gem
+  changelog_uri: https://github.com/hugem/turbovax-gem/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Quickly build vaccine twitter bots
+test_files: []