sevk 0.1.0

data/lib/sevk/resources/segments.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Sevk
+  module Resources
+    class Segments < Base
+      def list(audience_id, page: nil, limit: nil)
+        params = { page: page, limit: limit }
+        client.get("/audiences/#{audience_id}/segments#{build_query_string(params)}")
+      end
+
+      def get(audience_id, segment_id)
+        client.get("/audiences/#{audience_id}/segments/#{segment_id}")
+      end
+
+      def create(audience_id, name:, rules:, operator: "AND")
+        body = { name: name, rules: rules, operator: operator }
+        client.post("/audiences/#{audience_id}/segments", body)
+      end
+
+      def update(audience_id, segment_id, name: nil, rules: nil, operator: nil)
+        body = {}
+        body[:name] = name if name
+        body[:rules] = rules if rules
+        body[:operator] = operator if operator
+        client.put("/audiences/#{audience_id}/segments/#{segment_id}", body)
+      end
+
+      def delete(audience_id, segment_id)
+        client.delete("/audiences/#{audience_id}/segments/#{segment_id}")
+      end
+    end
+  end
+end

data/lib/sevk/resources/subscriptions.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Sevk
+  module Resources
+    class Subscriptions < Base
+      def subscribe(email:, audience_id:, topic_ids: nil, metadata: nil)
+        body = { email: email, audienceId: audience_id }
+        body[:topicIds] = topic_ids if topic_ids
+        body[:metadata] = metadata if metadata
+        client.post("/subscriptions/subscribe", body)
+      end
+
+      def unsubscribe(email:, audience_id: nil, topic_ids: nil)
+        body = { email: email }
+        body[:audienceId] = audience_id if audience_id
+        body[:topicIds] = topic_ids if topic_ids
+        client.post("/subscriptions/unsubscribe", body)
+      end
+    end
+  end
+end

data/lib/sevk/resources/templates.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Sevk
+  module Resources
+    class Templates < Base
+      def list(page: nil, limit: nil, search: nil)
+        params = { page: page, limit: limit, search: search }
+        client.get("/templates#{build_query_string(params)}")
+      end
+
+      def get(id)
+        client.get("/templates/#{id}")
+      end
+
+      def create(title:, content:)
+        client.post("/templates", { title: title, content: content })
+      end
+
+      def update(id, title: nil, content: nil)
+        body = {}
+        body[:title] = title if title
+        body[:content] = content if content
+        client.put("/templates/#{id}", body)
+      end
+
+      def delete(id)
+        client.delete("/templates/#{id}")
+      end
+
+      def duplicate(id)
+        client.post("/templates/#{id}/duplicate", {})
+      end
+    end
+  end
+end

data/lib/sevk/resources/topics.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Sevk
+  module Resources
+    class Topics < Base
+      def list(audience_id, page: nil, limit: nil)
+        params = { page: page, limit: limit }
+        client.get("/audiences/#{audience_id}/topics#{build_query_string(params)}")
+      end
+
+      def get(audience_id, topic_id)
+        client.get("/audiences/#{audience_id}/topics/#{topic_id}")
+      end
+
+      def create(audience_id, name:, description: nil)
+        body = { name: name }
+        body[:description] = description if description
+        client.post("/audiences/#{audience_id}/topics", body)
+      end
+
+      def update(audience_id, topic_id, name: nil, description: nil)
+        body = {}
+        body[:name] = name if name
+        body[:description] = description if description
+        client.put("/audiences/#{audience_id}/topics/#{topic_id}", body)
+      end
+
+      def delete(audience_id, topic_id)
+        client.delete("/audiences/#{audience_id}/topics/#{topic_id}")
+      end
+    end
+  end
+end

data/lib/sevk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sevk
+  VERSION = "0.1.0"
+end

data/lib/sevk.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/retry"
+require "json"
+
+require_relative "sevk/version"
+require_relative "sevk/error"
+require_relative "sevk/client"
+require_relative "sevk/resources/base"
+require_relative "sevk/resources/contacts"
+require_relative "sevk/resources/audiences"
+require_relative "sevk/resources/templates"
+require_relative "sevk/resources/broadcasts"
+require_relative "sevk/resources/domains"
+require_relative "sevk/resources/topics"
+require_relative "sevk/resources/segments"
+require_relative "sevk/resources/subscriptions"
+require_relative "sevk/resources/emails"
+require_relative "sevk/markup/renderer"
+
+module Sevk
+  DEFAULT_BASE_URL = "https://api.sevk.io"
+
+  class << self
+    attr_accessor :api_key, :base_url
+
+    def configure
+      yield self
+    end
+
+    def client
+      @client ||= Client.new(api_key: api_key, base_url: base_url)
+    end
+
+    def reset_client!
+      @client = nil
+    end
+  end
+
+  # Class-based API
+  module Contacts
+    class << self
+      def list(params = {})
+        Sevk.client.contacts.list(**params)
+      end
+
+      def get(id)
+        Sevk.client.contacts.get(id)
+      end
+
+      def create(params)
+        Sevk.client.contacts.create(**params)
+      end
+
+      def update(id, params)
+        Sevk.client.contacts.update(id, **params)
+      end
+
+      def delete(id)
+        Sevk.client.contacts.delete(id)
+      end
+    end
+  end
+
+  module Audiences
+    class << self
+      def list(params = {})
+        Sevk.client.audiences.list(**params)
+      end
+
+      def get(id)
+        Sevk.client.audiences.get(id)
+      end
+
+      def create(params)
+        Sevk.client.audiences.create(**params)
+      end
+
+      def update(id, params)
+        Sevk.client.audiences.update(id, **params)
+      end
+
+      def delete(id)
+        Sevk.client.audiences.delete(id)
+      end
+
+      def add_contacts(id, contact_ids)
+        Sevk.client.audiences.add_contacts(id, contact_ids)
+      end
+    end
+  end
+
+  module Templates
+    class << self
+      def list(params = {})
+        Sevk.client.templates.list(**params)
+      end
+
+      def get(id)
+        Sevk.client.templates.get(id)
+      end
+
+      def create(params)
+        Sevk.client.templates.create(**params)
+      end
+
+      def update(id, params)
+        Sevk.client.templates.update(id, **params)
+      end
+
+      def delete(id)
+        Sevk.client.templates.delete(id)
+      end
+
+      def duplicate(id)
+        Sevk.client.templates.duplicate(id)
+      end
+    end
+  end
+
+  module Broadcasts
+    class << self
+      def list(params = {})
+        Sevk.client.broadcasts.list(**params)
+      end
+
+      def get(id)
+        Sevk.client.broadcasts.get(id)
+      end
+    end
+  end
+
+  module Domains
+    class << self
+      def list(params = {})
+        Sevk.client.domains.list(**params)
+      end
+
+      def get(id)
+        Sevk.client.domains.get(id)
+      end
+    end
+  end
+
+  module Topics
+    class << self
+      def list(audience_id, params = {})
+        Sevk.client.topics.list(audience_id, **params)
+      end
+
+      def get(audience_id, topic_id)
+        Sevk.client.topics.get(audience_id, topic_id)
+      end
+
+      def create(audience_id, params)
+        Sevk.client.topics.create(audience_id, **params)
+      end
+
+      def update(audience_id, topic_id, params)
+        Sevk.client.topics.update(audience_id, topic_id, **params)
+      end
+
+      def delete(audience_id, topic_id)
+        Sevk.client.topics.delete(audience_id, topic_id)
+      end
+    end
+  end
+
+  module Segments
+    class << self
+      def list(audience_id, params = {})
+        Sevk.client.segments.list(audience_id, **params)
+      end
+
+      def get(audience_id, segment_id)
+        Sevk.client.segments.get(audience_id, segment_id)
+      end
+
+      def create(audience_id, params)
+        Sevk.client.segments.create(audience_id, **params)
+      end
+
+      def update(audience_id, segment_id, params)
+        Sevk.client.segments.update(audience_id, segment_id, **params)
+      end
+
+      def delete(audience_id, segment_id)
+        Sevk.client.segments.delete(audience_id, segment_id)
+      end
+    end
+  end
+
+  module Subscriptions
+    class << self
+      def subscribe(params)
+        Sevk.client.subscriptions.subscribe(**params)
+      end
+
+      def unsubscribe(params)
+        Sevk.client.subscriptions.unsubscribe(**params)
+      end
+    end
+  end
+
+  module Emails
+    class << self
+      def send(params)
+        Sevk.client.emails.send(**params)
+      end
+    end
+  end
+end

data/sevk.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/sevk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sevk"
+  spec.version       = Sevk::VERSION
+  spec.authors       = ["Sevk"]
+  spec.email         = ["dev@sevk.io"]
+
+  spec.summary       = "Ruby SDK for Sevk API"
+  spec.description   = "Ruby SDK for interacting with the Sevk API. Send emails, manage contacts, audiences, templates, and more."
+  spec.homepage      = "https://sevk.io"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sevk-io/sevk-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/sevk-io/sevk-ruby/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+  spec.add_dependency "faraday-retry", "~> 2.0"
+  spec.add_dependency "nokogiri", "~> 1.15"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: sevk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sevk
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: webmock
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby SDK for interacting with the Sevk API. Send emails, manage contacts,
+  audiences, templates, and more.
+email:
+- dev@sevk.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/sevk.rb
+- lib/sevk/client.rb
+- lib/sevk/error.rb
+- lib/sevk/markup/renderer.rb
+- lib/sevk/resources/audiences.rb
+- lib/sevk/resources/base.rb
+- lib/sevk/resources/broadcasts.rb
+- lib/sevk/resources/contacts.rb
+- lib/sevk/resources/domains.rb
+- lib/sevk/resources/emails.rb
+- lib/sevk/resources/segments.rb
+- lib/sevk/resources/subscriptions.rb
+- lib/sevk/resources/templates.rb
+- lib/sevk/resources/topics.rb
+- lib/sevk/version.rb
+- sevk.gemspec
+homepage: https://sevk.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://sevk.io
+  source_code_uri: https://github.com/sevk-io/sevk-ruby
+  changelog_uri: https://github.com/sevk-io/sevk-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby SDK for Sevk API
+test_files: []