chronicle-foursquare 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b127e38ea0c2b7e3393023e9d1deeab3b9b1ec098dbf8bcc1ad0dd16eb8ee107
-  data.tar.gz: 885e48e2f24f23182ff8ab04fae71caebb8713ba55e0e12b82f5f66c0ebc797a
+  metadata.gz: ebbe08ff2aed1578b59faa4de18500e7b8125e16da15f44987161af7b076ec7f
+  data.tar.gz: 5fc91f76c5b5b1e5fbe0e3c36cbe3b5f85fd7eaaf8a8f361686c75d3515b7078
 SHA512:
-  metadata.gz: 5d374d7055cc2eec0f690c5b2cc5f7f4bb62d985541064d3bc8215187f033b904660aa050b9b96faa00e6f10bedce4b753237779fbb6f0d4cf29548e1b0f40db
-  data.tar.gz: 3723eb0eec233292e9dc24c6d4e7b5db4f3854c6019ca3442a7d30659ed1d258b4833cf8a99d2f669a1e87abaaab636e4b2b0ea1799cb28ecc082906ddc33069
+  metadata.gz: 7ea5b83f185f9dc7387822fcbec917517edc1cb5ecc5ca9b220b4924224849703e6528c17432866de09f6fbdebbd40db36e6defa78385c603ac1854f39b28b60
+  data.tar.gz: de5b48c9e3c6175898b2f9801ebd963ffe4bd50a1377677b27b7318083ac8646e59a81ff97b2be82e387c3d85231c38af1dd85e0b10efa8b0ca3291ed985ecb3

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  chronicle-core: .rubocop-plugin.yml

data/Gemfile

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in chronicle-foursquare.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'

data/README.md

@@ -28,7 +28,7 @@ $ chronicle-etl secrets:set foursquare client_secret
 Next, we need an access token for accessing your data. We can use the authorization flow:
 
 ```sh
-$ chronicle-etl authorizations:new foursquare
+$ chronicle-etl authorizations:foursquare
 ```
 
 This will open a browser window to authorize on foursquare.com. When the flow is complete, access/refresh tokens will be saved in the chronicle secret system under the "foursquare" namespace. It'll be available automatically whenever you use this plugin.
@@ -37,23 +37,21 @@ This will open a browser window to authorize on foursquare.com. When the flow is
 ```sh
 # Extract recent checkins
 $ chronicle-etl --extractor foursquare --since 1w
+
 # Transform as Chronicle Schema
-$ chronicle-etl --extractor foursquare --since 1w --transformer foursquare --loader json
+$ chronicle-etl --extractor foursquare --since 1w --schema chronicle
+
+# Get a table of dates and place name
+$ chronicle-etl --extractor foursquare --since 1w --schema chronicle --fields end_time object.name --loader table
 ```
 
 ## Available Connectors
 
 ### Extractors
 
-#### `checkins`
+#### `checkin`
 
 Extractor for your Foursquare (via the Swarm app) checkins
 
 ##### Settings
 - `access_token`: (required) API access token for foursquare. By default, it's loaded from secrets under the `foursquare` namespace. You can check if it's available with `chronicle-etl secrets:list foursquare`
-
-### Transformers
-
-#### `visit`
-
-Transform a visit into Chronicle Schema

data/Rakefile

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 task default: %i[]

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "chronicle/foursquare"
+require 'bundler/setup'
+require 'chronicle/foursquare'
 
 # 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.
@@ -11,5 +11,5 @@ require "chronicle/foursquare"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/chronicle-foursquare.gemspec

@@ -1,46 +1,51 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "chronicle/foursquare/version"
+require 'chronicle/foursquare/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "chronicle-foursquare"
+  spec.name          = 'chronicle-foursquare'
   spec.version       = Chronicle::Foursquare::VERSION
-  spec.authors       = ["Andrew Louis"]
-  spec.email         = ["andrew@hyfen.net"]
+  spec.authors       = ['Andrew Louis']
+  spec.email         = ['andrew@hyfen.net']
 
-  spec.summary       = "Foursquare importer for Chronicle"
-  spec.description   = "Foursquare connectors"
-  spec.homepage      = "https://github.com/chronicle-app/chronicle-foursquare"
+  spec.summary       = 'Foursquare importer for Chronicle'
+  spec.description   = 'Foursquare connectors'
+  spec.homepage      = 'https://github.com/chronicle-app/chronicle-foursquare'
+
+  spec.required_ruby_version = '>= 3.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/chronicle-app/chronicle-foursquare"
-    spec.metadata["changelog_uri"] = "https://github.com/chronicle-app/chronicle-foursquare"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/chronicle-app/chronicle-foursquare'
+    spec.metadata['changelog_uri'] = 'https://github.com/chronicle-app/chronicle-foursquare'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
   end
 
   # 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('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "chronicle-etl", "~> 0.5"
-  spec.add_dependency "faraday", "~> 2"
-  spec.add_dependency "omniauth-oauth2", "~> 1"
-
-  spec.add_development_dependency "bundler", "~> 2.3"
-  spec.add_development_dependency "rake", "~> 13.0.6"
-  spec.add_development_dependency "pry-byebug", "~> 3.9"
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'chronicle-core', '~> 0.3'
+  spec.add_dependency 'chronicle-etl', '~> 0.6'
+  spec.add_dependency 'faraday', '~> 2'
+  spec.add_dependency 'omniauth-oauth2', '~> 1'
+
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'pry-byebug', '~> 3.10'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.63'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/chronicle/foursquare/authorizer.rb

@@ -5,12 +5,12 @@ module Chronicle
     class Authorizer < Chronicle::ETL::OauthAuthorizer
       provider :foursquare
       omniauth_strategy :foursquare
-      pluck_secrets({ 
-        access_token: [:credentials, :token],
+      pluck_secrets({
+        access_token: %i[credentials token],
         uid: [:uid],
-        first_name: [:info, :first_name],
-        last_name: [:info, :last_name],
-        email: [:info, :email],
+        first_name: %i[info first_name],
+        last_name: %i[info last_name],
+        email: %i[info email]
       })
     end
   end

data/lib/chronicle/foursquare/{checkins_extractor.rb → checkin_extractor.rb}

@@ -1,15 +1,17 @@
 module Chronicle
   module Foursquare
-    class CheckinsExtractor < Chronicle::ETL::Extractor
+    class CheckinExtractor < Chronicle::ETL::Extractor
       register_connector do |r|
-        r.provider = 'foursquare'
-        r.description = 'checkins'
+        r.source = :foursquare
+        r.type = :checkin
+        r.strategy = :api
+        r.description = 'foursquare checkin'
       end
 
       setting :access_token, required: true
 
       def prepare
-        raise(Chronicle::ETL::ExtractionError, "Access token is missing") if @config.access_token.empty?
+        raise(Chronicle::ETL::ExtractionError, 'Access token is missing') if @config.access_token.empty?
 
         @proxy = Chronicle::Foursquare::Proxy.new(access_token: @config.access_token)
         @actor = load_actor
@@ -22,7 +24,7 @@ module Chronicle
 
       def extract
         @checkins.each do |checkin|
-          yield Chronicle::ETL::Extraction.new(data: checkin, meta: { actor: @actor})
+          yield build_extraction(data: checkin, meta: { actor: @actor })
         end
       end
 

data/lib/chronicle/foursquare/checkin_transformer.rb

@@ -2,84 +2,79 @@ module Chronicle
   module Foursquare
     class CheckinTransformer < Chronicle::ETL::Transformer
       register_connector do |r|
-        r.provider = 'foursquare'
-        r.description = 'foursquare checkin'
-        r.identifier = 'checkin'
+        r.source = :foursquare
+        r.type = :checkin
+        r.strategy = :api
+        r.description = 'a checkin'
+        r.from_schema = :extraction
+        r.to_schema = :chronicle
       end
 
-      def transform
-        build_checkin
+      def transform(record)
+        checkin = record.data
+        actor = record.extraction.meta[:actor]
+        build_checkin(checkin, actor)
       end
 
-      def timestamp
-        Time.at(checkin[:createdAt])
-      end
+      private
 
-      def id
-        checkin[:id]
+      def build_checkin(checkin, actor)
+        Chronicle::Models::CheckInAction.new do |r|
+          r.source = 'foursquare'
+          r.end_time = Time.at(checkin[:createdAt])
+          r.agent = build_agent(actor)
+          r.object = build_venue(checkin)
+        end
       end
 
-      private
+      def build_venue(checkin)
+        venue = checkin[:venue]
+        location = venue[:location]
 
-      def build_checkin
-        record = ::Chronicle::ETL::Models::Activity.new
-        record.provider = 'foursquare'
-        record.end_at = timestamp
-        record.provider_id = id
-        record.lat = checkin[:venue][:location][:lat]
-        record.lng = checkin[:venue][:location][:lng]
-        record.dedupe_on << ['provider', 'provider_id', 'verb']
-        record.involved = build_venue
-        record.actor = build_actor
-        record
-      end
+        # TODO: represent categories (https://github.com/chronicle-app/chronicle-core/issues/10)
 
-      def build_venue
-        record = ::Chronicle::ETL::Models::Entity.new
-        record.provider = 'foursquare'
-        record.provider = checkin[:venue][:id]
-        record.represents = 'venue'
-        record.title = checkin[:venue][:name]
-        record.provider_id = checkin[:venue][:id]
-        record.lat = checkin[:venue][:location][:lat]
-        record.lng = checkin[:venue][:location][:lng]
-        record.dedupe_on << ['provider', 'provider_id', 'represents']
-        record.abouts = checkin[:venue][:categories].map{|category| build_category(category)}
-        record
-      end
+        Chronicle::Models::Place.new do |r|
+          r.source = 'foursquare'
+          r.name = venue[:name]
+          r.latitude = location[:lat]
+          r.longitude = location[:lng]
+          r.source_id = venue[:id]
 
-      def build_actor
-        record = ::Chronicle::ETL::Models::Entity.new
-        record.provider = 'foursquare'
-        record.represents = 'identity'
-        record.title = "#{actor[:firstName]} #{actor[:lastName]}"
-        record.provider_id = actor[:id]
-        record.provider_url = actor[:canonicalUrl]
-        record.dedupe_on << ['provider_url']
-        record.dedupe_on << ['provider', 'provider_id', 'represents']
-        record.attachments = [::Chronicle::ETL::Models::Attachment.new({
-          url_original: actor[:photo][:prefix] + "260x260" + actor[:photo][:suffix]
-        })]
-        record
-      end
+          r.address = Chronicle::Models::PostalAddress.new do |a|
+            a.description = location&.dig(:formattedAddress)&.join(', ')
+            a.address_country = location[:country]
+            a.address_locality = location[:city]
+            a.address_region = location[:state]
+            a.postal_code = location[:postalCode]
+            a.street_address = location[:address]
+          end
 
-      def build_category(category)
-        record = ::Chronicle::ETL::Models::Entity.new
-        record.provider = 'foursquare'
-        record.provider_id = category[:id]
-        record.represents = 'topic'
-        record.title = category[:name]
-        record.dedupe_on << ['provider', 'provider_id', 'represents']
-        record
+          r.dedupe_on = [%i[source source_id type]]
+        end
       end
 
-      def checkin
-        @checkin ||= @extraction.data
-      end
+      def build_agent(actor)
+        image_url = "#{actor[:photo][:prefix]}260x260#{actor[:photo][:suffix]}"
+        name = "#{actor[:firstName]} #{actor[:lastName]}"
 
-      def actor
-        @actor ||= @extraction.meta[:actor]
+        Chronicle::Models::Person.new do |r|
+          r.source = 'foursquare'
+          r.name = name
+          r.image = image_url
+          r.source_id = actor[:id]
+          r.url = actor[:canonicalUrl]
+        end
       end
+
+      # def build_category(category)
+      #   record = ::Chronicle::ETL::Models::Entity.new
+      #   record.provider = 'foursquare'
+      #   record.provider_id = category[:id]
+      #   record.represents = 'topic'
+      #   record.title = category[:name]
+      #   record.dedupe_on << ['provider', 'provider_id', 'represents']
+      #   record
+      # end
     end
   end
 end

data/lib/chronicle/foursquare/proxy.rb

@@ -3,9 +3,9 @@ require 'faraday'
 module Chronicle
   module Foursquare
     class Proxy
-      API_VERSION = 20170310
+      API_VERSION = 20_170_310
 
-      def initialize(access_token: )
+      def initialize(access_token:)
         @access_token = access_token
       end
 
@@ -39,7 +39,7 @@ module Chronicle
         load_endpoint('users/self/checkins', params)[:response][:checkins][:items]
       end
 
-      def load_endpoint(endpoint, params={})
+      def load_endpoint(endpoint, params = {})
         params = params.merge({
           oauth_token: @access_token,
           v: API_VERSION

data/lib/chronicle/foursquare/version.rb

@@ -2,6 +2,6 @@
 
 module Chronicle
   module Foursquare
-    VERSION = "0.1.1"
+    VERSION = '0.2.0'
   end
 end

data/lib/chronicle/foursquare.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require 'chronicle/etl'
+require 'chronicle/models'
 
-require_relative "foursquare/version"
-require_relative "../omniauth/strategies/foursquare"
-require_relative "foursquare/proxy"
-require_relative "foursquare/authorizer"
-require_relative "foursquare/checkins_extractor"
-require_relative "foursquare/checkin_transformer"
+require_relative 'foursquare/version'
+require_relative '../omniauth/strategies/foursquare'
+require_relative 'foursquare/proxy'
+require_relative 'foursquare/authorizer'
+require_relative 'foursquare/checkin_extractor'
+require_relative 'foursquare/checkin_transformer'

data/lib/omniauth/strategies/foursquare.rb

@@ -11,28 +11,28 @@ module OmniAuth
   module Strategies
     class Foursquare < OmniAuth::Strategies::OAuth2
       option :client_options, {
-        :site => 'https://foursquare.com',
-        :authorize_url => '/oauth2/authenticate',
-        :token_url => '/oauth2/access_token'
+        site: 'https://foursquare.com',
+        authorize_url: '/oauth2/authenticate',
+        token_url: '/oauth2/access_token'
       }
 
       uid { raw_info['id'] }
 
       info do
         {
-          :first_name  => raw_info['firstName'],
-          :last_name   => raw_info['lastName'],
-          :name        => "#{raw_info['firstName']} #{raw_info['lastName']}",
-          :email       => (raw_info['contact'] || {})['email'],
-          :phone       => (raw_info['contact'] || {})['phone'],
-          :image       => raw_info['photo'],
-          :location    => raw_info['homeCity'],
-          :description => raw_info['bio']
+          first_name: raw_info['firstName'],
+          last_name: raw_info['lastName'],
+          name: "#{raw_info['firstName']} #{raw_info['lastName']}",
+          email: (raw_info['contact'] || {})['email'],
+          phone: (raw_info['contact'] || {})['phone'],
+          image: raw_info['photo'],
+          location: raw_info['homeCity'],
+          description: raw_info['bio']
         }
       end
 
       extra do
-        { :raw_info => raw_info }
+        { raw_info: raw_info }
       end
 
       def request_phase
@@ -41,8 +41,12 @@ module OmniAuth
       end
 
       def auth_hash
-        OmniAuth::Utils.deep_merge(super, client_params.merge({
-          :grant_type => 'authorization_code'}))
+        OmniAuth::Utils.deep_merge(super,
+          client_params.merge(
+            {
+              grant_type: 'authorization_code'
+            }
+          ))
       end
 
       def raw_info
@@ -54,7 +58,7 @@ module OmniAuth
       private
 
       def client_params
-        {:client_id => options[:client_id], :redirect_uri => callback_url ,:response_type => "code"}
+        { client_id: options[:client_id], redirect_uri: callback_url, response_type: 'code' }
       end
     end
   end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-foursquare
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Louis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronicle-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: chronicle-etl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +80,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.63'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.63'
 description: Foursquare connectors
 email:
 - andrew@hyfen.net
@@ -102,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -111,8 +140,8 @@ files:
 - chronicle-foursquare.gemspec
 - lib/chronicle/foursquare.rb
 - lib/chronicle/foursquare/authorizer.rb
+- lib/chronicle/foursquare/checkin_extractor.rb
 - lib/chronicle/foursquare/checkin_transformer.rb
-- lib/chronicle/foursquare/checkins_extractor.rb
 - lib/chronicle/foursquare/proxy.rb
 - lib/chronicle/foursquare/version.rb
 - lib/omniauth/strategies/foursquare.rb
@@ -123,6 +152,7 @@ metadata:
   homepage_uri: https://github.com/chronicle-app/chronicle-foursquare
   source_code_uri: https://github.com/chronicle-app/chronicle-foursquare
   changelog_uri: https://github.com/chronicle-app/chronicle-foursquare
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -131,14 +161,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Foursquare importer for Chronicle