pdsdk 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6e27cba82c9da8c61a3346c8cb3396095dc56f075fc0af2fdcd76e7e7b2d564
+  data.tar.gz: 0df1c31b925550e9632dc39c5c22e63925aadf8b8b5e51cd966ee77181395f03
+SHA512:
+  metadata.gz: 667976438fad199ff9d465a79ee022d040c5f5a160fe45757870b9ba05e546490710d18aafdeae550aa02b0f0badeaa56786550ce0f2eee2cff58b85813bd2d2
+  data.tar.gz: 1f5cd72717b8223a87715a03c51bb2779b4edf3113c79e575b8c88e3266dd3292feaf7f65868d01d6a18651a0c04468edda39065008d8e39e68982d4b2b91b2d

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    pipedream (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    keycutter (1.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  keycutter
+  pipedream!
+  rspec
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,29 @@
+# sdk:ruby
+
+```ruby
+require "pdsdk"
+
+Pdsdk.send_event(API_KEY, hello: "world")
+
+# with exports
+Pdsdk.send_event(API_KEY, {
+  hello: "world"
+}, exports: {
+  event: { hello: "world!" },
+  other_export: "howdy",
+})
+```
+
+If you do not provide an `event` export it will be set to the `raw_event` (first argument).  `event` and `raw_event` MUST be a hash or the SDK request will be invalid.
+
+## Development
+
+Setup: https://help.github.com/en/articles/configuring-rubygems-for-use-with-github-package-registry#authenticating-to-github-package-registry
+
+To cut new version (TODO automate this):
+
+```
+# update lib/pdsdk/version.rb to $VERSION
+gem build pdsdk.gemspec
+gem push pdsdk-$VERSION.gem
+```

data/lib/pdsdk/base.rb

@@ -0,0 +1,83 @@
+require "pdsdk/version"
+require "pdsdk/logger"
+require "json"
+
+module Pdsdk
+  class Error < StandardError
+  end
+
+  # TODO share these strings in some json config file across all SDKs?
+  ENV_KEY_PREFIX = "PD_"
+  ENV_SECRET_KEY_KEY = "#{ENV_KEY_PREFIX}SECRET_KEY"
+
+  class << self
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def logger=(v)
+      @logger = v
+    end
+
+    def bootstrap!
+      logger.info "bootstrapping..."
+
+      @secret_key = ENV[ENV_SECRET_KEY_KEY]
+      if !@secret_key
+        logger.warn "no $#{ENV_SECRET_KEY_KEY} detected, will not sign payloads"
+      end
+    end
+
+    # XXX self.send_message for string and becomes { message } ?
+    def send_event(api_key, raw_event, opts={})
+      hostname = ENV["PD_SDK_HOST"] || "sdk.m.pipedream.net"
+      proto = ENV["PD_SDK_PROTO"] || "https"
+      event = opts[:exports] || {}
+      event[:raw_event] = raw_event
+      if opts[:deployment]
+        _uri = "#{proto}://#{hostname}/pipelines/#{api_key}/deployments/#{opts[:deployment]}/events"
+      else
+        _uri = "#{proto}://#{hostname}/pipelines/#{api_key}/events"
+      end
+      uri = URI(_uri)
+      use_ssl = uri.scheme == "https"
+      @https ||= {}
+      # TODO ensure reconnects if client disconnects
+      @https[_uri] = http ||= Net::HTTP.start(uri.host, uri.port, use_ssl: use_ssl) # XXX assume https
+      logger.info "going to send event: #{event}" # TODO remove
+      payload = event.to_json
+      headers = {
+        "user-agent" => "pipedream-sdk:ruby/1",
+        "content-type" => "application/json",
+        "x-pd-sdk-version" => Pdsdk::VERSION,
+      }
+      headers["x-pd-sig"] = "sha256=#{OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @secret_key, payload)}" if @secret_key
+      req = Net::HTTP::Post.new(uri.request_uri, headers)
+      req.body = payload
+      resp = http.request(req)
+      logger.info "received response: #{resp}" # TODO remove
+      # XXX check we get { "success": "ok" } back?
+      resp.code.to_i
+    end
+
+    def load_metadata(metadata_path, merge_data)
+      metadata = {}
+      begin
+        metadata = JSON.parse(File.read(metadata_path))
+      rescue
+        # assume the service is not METADATA'ed, hence LOCAL development
+        branch = `git rev-parse --abbrev-ref HEAD`.strip rescue nil
+        metadata[:branch] = branch if !branch.blank?
+        git_ref = `git rev-parse HEAD`.strip rescue nil
+        metadata[:git_ref] = git_ref if !git_ref.blank?
+      end
+      metadata[:pdsdk_version] = Pdsdk::VERSION
+      metadata[:started_at] = Time.now.to_f
+      metadata[:name] = ENV["PD_METADATA_NAME"] || `hostname`.strip
+      metadata.merge!(merge_data) # XXX deep?
+      metadata
+    end
+  end
+end
+
+Pdsdk.bootstrap!

data/lib/pdsdk/clients/base.rb

@@ -0,0 +1,4 @@
+module Pdsdk
+  class Base
+  end
+end

data/lib/pdsdk/logger.rb

@@ -0,0 +1,18 @@
+require "logger"
+
+module Pdsdk
+  class Logger < ::Logger
+    LOG_PREFIX = "** [pdsdk] ".freeze
+    PROGNAME = "pdsdk"
+
+    def initialize(*)
+      super
+      @level = ::Logger::INFO
+      original_formatter = ::Logger::Formatter.new
+      @default_formatter = proc do |severity, datetime, _progname, msg|
+        msg = "#{LOG_PREFIX}#{msg}"
+        original_formatter.call(severity, datetime, PROGNAME, msg)
+      end
+    end
+  end
+end

data/lib/pdsdk/version.rb

@@ -0,0 +1,3 @@
+module Pdsdk
+  VERSION = "0.3.0"
+end

data/lib/pdsdk.rb

@@ -0,0 +1 @@
+require "pdsdk/base"

data/pdsdk.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require "pdsdk/version"
+
+Gem::Specification.new do |g|
+  g.name = "pdsdk"
+  g.version = Pdsdk::VERSION
+  g.date = "2019-10-14"
+  g.summary = g.description = "Pipedream SDK"
+  g.authors = ["Pipedream Team"]
+  g.email = "engineering@pipedream.com"
+  g.files = `git ls-files`.split("\n")
+  g.homepage = "https://github.com/PipedreamHQ/sdk/blob/master/ruby"
+  g.license = "MIT"
+  g.add_development_dependency "keycutter"
+  g.metadata = {"github_repo" => "ssh://github.com/PipedreamHQ/sdk"}
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: pdsdk
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Pipedream Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: keycutter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pipedream SDK
+email: engineering@pipedream.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/pdsdk.rb
+- lib/pdsdk/base.rb
+- lib/pdsdk/clients/base.rb
+- lib/pdsdk/logger.rb
+- lib/pdsdk/version.rb
+- pdsdk.gemspec
+homepage: https://github.com/PipedreamHQ/sdk/blob/master/ruby
+licenses:
+- MIT
+metadata:
+  github_repo: ssh://github.com/PipedreamHQ/sdk
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Pipedream SDK
+test_files: []