adobe-campaign 0.1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de1679f1ea719170ca93ad2f55aee14d102f30a7
+  data.tar.gz: d57b65eb5e6bd7e21574e84625eb4e201353c4c1
+SHA512:
+  metadata.gz: a34d6979b594397ddc4c87630f17666a693f38d071c3d282e773e129b7171502423e1fb9a6c57221362cb9a65f706a289a8024f1bca13172057c0812c8cd5198
+  data.tar.gz: 0aece9875ca3c0ad716e88ce247fa36736412a326814b162be8bddc75207eaff63fb50e1c03d52e012166394e14d48614ad2641e7d94fd640dd859c05367c6ae

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/cache/
+/vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  Include:
+    - Rakefile
+    - config.ru
+    - lib/tasks/**/*.rake
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+
+  UseCache: true
+  CacheRootDirectory: 'cache/'
+  TargetRubyVersion: 2.3
+
+Rails:
+  Enabled: true
+
+Documentation:
+  Enabled: false
+
+MethodLength:
+  Severity: warning
+  Max: 15
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/ClassLength:
+  Max: 200

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in adobe-campaign.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :rubocop, cli: ['--format', 'clang', '--auto-correct'] do
+  watch(/.+\.rb$/)
+  watch(/.+\.rake$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -0,0 +1,34 @@
+# Adobe::Campaign
+
+Based off the documentation here: https://docs.campaign.adobe.com/doc/standard/en/api/ACS_API.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adobe-campaign'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adobe-campaign
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/soberstadt/adobe-campaign.
+

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+import './lib/tasks/adobe.rake'

data/adobe-campaign.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adobe/campaign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adobe-campaign'
+  spec.version       = Adobe::Campaign::VERSION
+  spec.authors       = ['Spencer Oberstadt']
+  spec.email         = ['soberstadt@gmail.com']
+
+  spec.summary       = 'A ruby wrapper for connecting your Rails app with Adobe Campaign.'
+  spec.homepage      = 'https://github.com/soberstadt/adobe-campaign'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rails', '>= 3.1'
+  spec.add_runtime_dependency 'activesupport', '>= 3.1.0'
+  spec.add_runtime_dependency 'rest-client', '>= 1.6.0'
+  spec.add_runtime_dependency 'jwt', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard-rubocop'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'adobe/campaign'
+
+# 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

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/lib/adobe/campaign.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'rest-client'
+
+require 'adobe/campaign/version'
+require 'adobe/campaign/configuration'
+require 'adobe/campaign/railtie' if defined? ::Rails::Railtie
+require 'adobe/campaign/base'
+require 'adobe/campaign/profile'
+require 'adobe/campaign/service'
+
+module Adobe
+  module Campaign
+  end
+end

data/lib/adobe/campaign/base.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+module Adobe
+  module Campaign
+    class Base
+      class << self
+        def endpoint
+          raise 'You can not call requests directly on Adobe::Campaign::Base'
+        end
+
+        def all
+          get_request(endpoint)
+        end
+
+        def find(search_text)
+          get_request("#{endpoint}/byText?text=#{search_text}")
+        end
+
+        def post(body)
+          post_request(endpoint, body)
+        end
+
+        def get_request(url)
+          full_url = url_prefix(url)
+          resp = RestClient::Request.execute(
+            method: :get,
+            url: full_url,
+            headers: Adobe::Campaign::Base.auth_headers
+          )
+          JSON.parse(resp.body)
+        end
+
+        def post_request(url, body)
+          full_url = url_prefix(url)
+          json = body.is_a?(String) ? body : body.to_json
+          resp = RestClient.post(full_url, json, auth_headers.merge('Content-Type' => 'application/json'))
+          JSON.parse(resp.body)
+        end
+
+        def auth_headers
+          {
+            'Authorization' => "Bearer #{access_token}",
+            'X-Api-Key' => Adobe::Campaign.configuration.api_key
+          }
+        end
+
+        def access_token
+          Adobe::Campaign::Base.load_access_token
+        end
+
+        def load_access_token
+          return @access_token if @access_token && @access_token_expires > Time.zone.now
+          as_url = "https://#{Adobe::Campaign.configuration.ims_host}/ims/exchange/jwt"
+          as_payload = {
+            client_id: Adobe::Campaign.configuration.api_key,
+            client_secret: Adobe::Campaign.configuration.api_secret,
+            jwt_token: Adobe::Campaign.configuration.signed_jwt
+          }
+          access_token_resp = RestClient.post(as_url, as_payload, {})
+          json = JSON.parse(access_token_resp.body)
+          @access_token_expires = 1439.minutes.from_now
+          @access_token = json.dig('access_token')
+        end
+
+        protected
+
+        def url_prefix(url)
+          url.starts_with?('http') ? url : url_join('https://mc.adobe.io/cru/campaign/', url)
+        end
+
+        def url_join(*args)
+          base = args.map { |arg| arg.gsub(%r{^/*(.*?)/*$}, '\1') }.join('/')
+          args.last.ends_with?('/') ? "#{base}/" : base
+        end
+      end
+    end
+  end
+end

data/lib/adobe/campaign/configuration.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Adobe
+  module Campaign
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    class Configuration
+      # Required. The issuer, your organization ID in the format org_ident@AdobeOrg.
+      attr_accessor :org_id
+
+      # Required. The subject, your API client account ID in the format: id@techacct.adobe.com.
+      attr_accessor :tech_acct
+
+      # Required. Api key retrieved from https://www.adobe.io/console/integrations
+      attr_accessor :api_key
+      attr_accessor :api_secret
+
+      attr_accessor :signed_jwt
+
+      attr_accessor :ims_host
+
+      def initialize
+        @org_id = ''
+        @tech_acct = ''
+        @api_key = ''
+        @api_secret = ''
+        @signed_jwt = ''
+        @ims_host = 'ims-na1.adobelogin.com'
+      end
+    end
+  end
+end

data/lib/adobe/campaign/profile.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module Adobe
+  module Campaign
+    class Profile < Adobe::Campaign::Base
+      def self.endpoint
+        'profileAndServices/profile'
+      end
+
+      def self.by_email(search_text)
+        get_request("#{endpoint}/byEmail?email=#{search_text}")
+      end
+
+      def self.profile_subscriptions(person_pkey)
+        get_request("#{endpoint}/#{person_pkey}/subscriptions/")
+      end
+
+      # Example Create Payload
+      # {
+      #   "birthDate": '',
+      #   "email": 'a.test@cru.org',
+      #   "emailFormat": 'unknown',
+      #   "fax": '',
+      #   "firstName": 'A Test',
+      #   "gender": 'male',
+      #   "lastName": 'Profile',
+      #   "location": {
+      #     "address1": '123 North St',
+      #     "address2": '',
+      #     "address3": '',
+      #     "address4": '',
+      #     "city": 'Orlando',
+      #     "countryCode": 'US',
+      #     "stateCode": 'FL',
+      #     "zipCode": '32714'
+      #   },
+      #   "middleName": '',
+      #   "mobilePhone": '',
+      #   "phone": '',
+      #   "salutation": 'Mr'
+      # }
+    end
+  end
+end

data/lib/adobe/campaign/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Adobe
+  module Campaign
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load File.join(File.dirname(__FILE__), '../../tasks/adobe.rake')
+      end
+    end
+  end
+end

data/lib/adobe/campaign/service.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Adobe
+  module Campaign
+    class Service < Adobe::Campaign::Base
+      def self.endpoint
+        'profileAndServices/service'
+      end
+
+      def self.post_subscription(service_subs_url, person_pkey)
+        payload = {
+          'subscriber' => {
+            'PKey' => person_pkey
+          }
+        }
+        post_request(service_subs_url, payload)
+      end
+    end
+  end
+end

data/lib/adobe/campaign/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Adobe
+  module Campaign
+    VERSION = '0.1.0.1'
+  end
+end

data/lib/tasks/adobe.rake

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# rubocop:disable Metrics/BlockLength
+require 'jwt'
+require 'adobe/campaign'
+
+namespace :adobe do
+  desc 'Generate a long-life JWT for exchanging with the adobelogic server'
+  task :generate_jwt do
+    unless ENV['key']
+      puts 'You must include a reference to the private key'
+      puts 'example: rake adobe:generate_jwt key=~/certs/adobe/private.key'
+      exit 1
+    end
+
+    key_path = File.expand_path(ENV['key'])
+    unless File.exist? key_path
+      puts 'private key does not exist!'
+      exit 1
+    end
+
+    org_id = Adobe::Campaign.configuration.org_id
+    tech_acct = Adobe::Campaign.configuration.tech_acct
+    api_key = Adobe::Campaign.configuration.api_key
+    ims_host = Adobe::Campaign.configuration.ims_host
+    payload = {
+      'exp' => 1.year.from_now.to_time.to_i,
+      'iss' => "#{org_id}@AdobeOrg",
+      'sub' => "#{tech_acct}@techacct.adobe.com",
+      'aud' => "https://#{ims_host}/c/#{api_key}",
+      "https://#{ims_host}/s/ent_campaign_sdk" => true
+    }
+    priv_key = OpenSSL::PKey::RSA.new(File.read(key_path))
+    signed_jwt = JWT.encode(payload, priv_key, 'RS256')
+    puts 'Your new signed JWT:'
+    puts signed_jwt
+    puts "It will expire: #{10.years.from_now}"
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: adobe-campaign
+version: !ruby/object:Gem::Version
+  version: 0.1.0.1
+platform: ruby
+authors:
+- Spencer Oberstadt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  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: 
+email:
+- soberstadt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- adobe-campaign.gemspec
+- bin/console
+- bin/setup
+- lib/adobe/campaign.rb
+- lib/adobe/campaign/base.rb
+- lib/adobe/campaign/configuration.rb
+- lib/adobe/campaign/profile.rb
+- lib/adobe/campaign/railtie.rb
+- lib/adobe/campaign/service.rb
+- lib/adobe/campaign/version.rb
+- lib/tasks/adobe.rake
+homepage: https://github.com/soberstadt/adobe-campaign
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for connecting your Rails app with Adobe Campaign.
+test_files: []