chronicle-foursquare 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0e123371d8afe2ec990238902f728d6fc7c826494b317cdd9809dd118624d3d
+  data.tar.gz: 1f6927a304ca2e6526b7e50540bf72765de4099fcccb34d394e7fd950f9cf5f6
+SHA512:
+  metadata.gz: 4172b70d9503bdaa5316962484af18753b271ee5a55049dab2897539be6636a27345ede2007fd508ffca92b8d0d38b24a2d66d81737cc7b256c08277ab74fa40
+  data.tar.gz: b7d58fed039ba3d03567c16c0599dc111b273b0c136cd4d2aa08057ffb5ef090438c4725db3a8d5d358fd5ac8dd91c67eefaa194ff603c529626a7fc47c92c3a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at andrew@hyfen.net. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/README.md

@@ -0,0 +1,59 @@
+# Chronicle::Foursquare
+[![Gem Version](https://badge.fury.io/rb/chronicle-foursquare.svg)](https://badge.fury.io/rb/chronicle-foursquare)
+
+Extract your Foursquare/Swarm history using the command line with this plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl).
+
+## Usage
+
+### 1. Install Chronicle-ETL and this plugin
+
+```sh
+# Install chronicle-etl and this plugin
+$ gem install chronicle-etl
+$ chronicle-etl plugins:install foursquare
+```
+
+### 2. Create a Foursquare App
+To get access to the Foursquare API, you must first create an app. Press the "Create New Project" button in the [Developer Home](https://foursquare.com/developers/home).
+
+In the app's setting, in the `Redirect URIs` field, add `http://localhost:4567/auth/foursquare/callback`. After your app has been saved, grab the `client_id` and `client_secret` credentials and save them to chronicle-etl secrets:
+
+```sh
+$ chronicle-etl secrets:set foursquare client_id
+$ chronicle-etl secrets:set foursquare client_secret
+```
+
+### 3. Authorize Foursquare
+
+Next, we need an access token for accessing your data. We can use the authorization flow:
+
+```sh
+$ chronicle-etl authorizations:new 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.
+
+### 4. Use the the plugin
+```sh
+# Extract recent checkins
+$ chronicle-etl --extractor foursquare --since 1w
+# Transform as Chronicle Schema
+$ chronicle-etl --extractor foursquare --since 1w --transformer foursquare --loader json
+```
+
+## Available Connectors
+
+### Extractors
+
+#### `visits`
+
+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

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chronicle-foursquare.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chronicle/foursquare/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chronicle-foursquare"
+  spec.version       = Chronicle::Foursquare::VERSION
+  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"
+
+  # 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["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."
+  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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  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"
+end

data/lib/chronicle/foursquare/authorizer.rb

@@ -0,0 +1,17 @@
+require 'chronicle/etl/oauth_authorizer'
+
+module Chronicle
+  module Foursquare
+    class Authorizer < Chronicle::ETL::OauthAuthorizer
+      provider :foursquare
+      omniauth_strategy :foursquare
+      pluck_secrets({ 
+        access_token: [:credentials, :token],
+        uid: [:uid],
+        first_name: [:info, :first_name],
+        last_name: [:info, :last_name],
+        email: [:info, :email],
+      })
+    end
+  end
+end

data/lib/chronicle/foursquare/checkin_transformer.rb

@@ -0,0 +1,85 @@
+module Chronicle
+  module Foursquare
+    class CheckinTransformer < Chronicle::ETL::Transformer
+      register_connector do |r|
+        r.provider = 'foursquare'
+        r.description = 'foursquare checkin'
+        r.identifier = 'checkin'
+      end
+
+      def transform
+        build_checkin
+      end
+
+      def timestamp
+        Time.at(checkin[:createdAt])
+      end
+
+      def id
+        checkin[:id]
+      end
+
+      private
+
+      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
+
+      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
+
+      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
+
+      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
+
+      def checkin
+        @checkin ||= @extraction.data
+      end
+
+      def actor
+        @actor ||= @extraction.meta[:actor]
+      end
+    end
+  end
+end

data/lib/chronicle/foursquare/proxy.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+
+module Chronicle
+  module Foursquare
+    class Proxy
+      API_VERSION = 20170310
+
+      def initialize(access_token: )
+        @access_token = access_token
+      end
+
+      def load_visits(since: nil, limit: nil)
+        has_more = true
+        visits = []
+        count = 0
+
+        while has_more
+          results = load_checkins(limit: 50, offset: count, since: since)
+          results = results.first(limit - count) if limit
+          visits += results
+
+          count += results.length
+          has_more = results.any?
+        end
+        visits
+      end
+
+      def load_self
+        load_endpoint('users/self')[:response][:user]
+      end
+
+      def load_checkins(limit: 50, offset: 0, since: nil)
+        params = {
+          limit: limit,
+          offset: offset,
+          afterTimestamp: since.to_i
+        }
+
+        load_endpoint('users/self/checkins', params)[:response][:checkins][:items]
+      end
+
+      def load_endpoint(endpoint, params={})
+        params = params.merge({
+          oauth_token: @access_token,
+          v: API_VERSION
+        })
+
+        conn = Faraday.new(
+          url: 'https://api.foursquare.com/v2/',
+          params: params
+        )
+
+        response = conn.get(endpoint)
+        JSON.parse(response.body, { symbolize_names: true })
+      end
+    end
+  end
+end

data/lib/chronicle/foursquare/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Chronicle
+  module Foursquare
+    VERSION = "0.1.0"
+  end
+end

data/lib/chronicle/foursquare/visits_extractor.rb

@@ -0,0 +1,40 @@
+module Chronicle
+  module Foursquare
+    class VisitsExtractor < Chronicle::ETL::Extractor
+      register_connector do |r|
+        r.provider = 'foursquare'
+        r.description = 'visits'
+      end
+
+      setting :access_token, required: true
+
+      def prepare
+        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
+        @visits = load_visits
+      end
+
+      def results_count
+        @visits.count
+      end
+
+      def extract
+        @visits.each do |visit|
+          yield Chronicle::ETL::Extraction.new(data: visit, meta: { actor: @actor})
+        end
+      end
+
+      private
+
+      def load_visits
+        @proxy.load_visits(limit: @config.limit, since: @config.since)
+      end
+
+      def load_actor
+        @proxy.load_self
+      end
+    end
+  end
+end

data/lib/chronicle/foursquare.rb

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

data/lib/omniauth/strategies/foursquare.rb

@@ -0,0 +1,61 @@
+# Copied from https://github.com/raysrashmi/omniauth-foursquare
+#
+# Dependencies on the gem are old but the strategy still works fine
+# on its own
+#
+# License: MIT
+
+require 'omniauth-oauth2'
+
+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'
+      }
+
+      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']
+        }
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def request_phase
+        options[:authorize_params] = client_params.merge(options[:authorize_params])
+        super
+      end
+
+      def auth_hash
+        OmniAuth::Utils.deep_merge(super, client_params.merge({
+          :grant_type => 'authorization_code'}))
+      end
+
+      def raw_info
+        access_token.options[:mode] = :query
+        access_token.options[:param_name] = :oauth_token
+        @raw_info ||= access_token.get('https://api.foursquare.com/v2/users/self?v=20140128').parsed['response']['user']
+      end
+
+      private
+
+      def client_params
+        {:client_id => options[:client_id], :redirect_uri => callback_url ,:response_type => "code"}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: chronicle-foursquare
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Louis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronicle-etl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Foursquare connectors
+email:
+- andrew@hyfen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chronicle-foursquare.gemspec
+- lib/chronicle/foursquare.rb
+- lib/chronicle/foursquare/authorizer.rb
+- lib/chronicle/foursquare/checkin_transformer.rb
+- lib/chronicle/foursquare/proxy.rb
+- lib/chronicle/foursquare/version.rb
+- lib/chronicle/foursquare/visits_extractor.rb
+- lib/omniauth/strategies/foursquare.rb
+homepage: https://github.com/chronicle-app/chronicle-foursquare
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  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
+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: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Foursquare importer for Chronicle
+test_files: []