stannp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df463198452eace393468c01970f5a2d5f0aca063bfebd9e98a059b006525e66
+  data.tar.gz: c0e810b647919ca53513ccb0d35010aeb5afeed348a2c2325d2cdde4ed658fd3
+SHA512:
+  metadata.gz: f84d3718a853fda778d709769141be754c250f99ee65de980307a98fbf1133b7b68f2d9e8b568007aaf9a4c88684189f38f9714002b6d50ea4c6ba58fc40c1ca
+  data.tar.gz: 7a5a4e153c5822dcac9888b98bf7560ea7c76895f88fe0df5022596ff4edbe1667a5d09413916370f138b1e80f84bbb53a4944c973248a0fea6ea6f54cb7299f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+    - 'vendor/**/*'
+    - 'vendor/**/.*'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stannp.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 k-p-jones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Stannp
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stannp`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stannp'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install stannp
+
+## 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 the created tag, 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/[USERNAME]/stannp.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module Stannp
+  class Client
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+      @stubs = stubs
+    end
+
+    def account
+      AccountResource.new(client: self)
+    end
+
+    def user
+      UserResource.new(client: self)
+    end
+
+    def recipients
+      RecipientsResource.new(client: self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.request :json
+        conn.response :json, content_type: 'application/json'
+        conn.adapter adapter, stubs
+      end
+    end
+
+    private
+
+    attr_reader :stubs
+  end
+end

data/lib/stannp/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class Error < StandardError; end
+end

data/lib/stannp/list.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Stannp
+  class List
+    attr_reader :data
+
+    def self.from_request(data:, type:)
+      new(data: data.map { |attrs| type.new(attrs) })
+    end
+
+    def initialize(data:)
+      @data = data
+    end
+  end
+end

data/lib/stannp/object.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Stannp
+  class Object
+    attr_reader :attributes
+
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      value = attributes.send(method, *args, &block)
+      case value
+      when Hash
+        Object.new(value)
+      when Array
+        value.map { |item| item.is_a?(Hash) ? Object.new(item) : item }
+      else
+        value
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      attributes.to_h.keys.include?(method) || super
+    end
+  end
+end

data/lib/stannp/objects/recipient.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class Recipient < Object; end
+end

data/lib/stannp/objects/user.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class User < Object; end
+end

data/lib/stannp/resource.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Stannp
+  class Resource
+    def initialize(client:)
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response(client.connection.get(url, params, headers))
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    private
+
+    attr_reader :client
+
+    def handle_response(response)
+      raise Error, "#{response.status}: #{response.body["error"]}" unless response.success?
+
+      response
+    end
+  end
+end

data/lib/stannp/resources/account.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Stannp
+  class AccountResource < Resource
+    def balance
+      url = "https://dash.stannp.com/api/v1/accounts/balance?api_key=#{client.api_key}}"
+      get_request(url).body['data']['balance']
+    end
+  end
+end

data/lib/stannp/resources/recipients.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Stannp
+  class RecipientsResource < Resource
+    def list(group_id: nil)
+      id = group_id ? "/#{group_id}" : ''
+      url = "https://dash.stannp.com/api/v1/recipients/list#{id}?api_key=#{client.api_key}"
+      List.from_request(data: get_request(url).body['data'], type: Recipient)
+    end
+
+    def get(id:)
+      url = "https://dash.stannp.com/api/v1/recipients/get/#{id}?api_key=#{client.api_key}"
+      Recipient.new(get_request(url).body['data'])
+    end
+
+    def create(attributes:)
+      url = "https://dash.stannp.com/api/v1/recipients/new?api_key=#{client.api_key}"
+      Recipient.new(post_request(url, body: attributes).body['data'])
+    end
+
+    def delete(id:)
+      url = "https://dash.stannp.com/api/v1/recipients/delete?api_key=#{client.api_key}"
+      post_request(url, body: { id: id.to_i })
+      true
+    end
+
+    def delete_all
+      url = "https://dash.stannp.com/api/v1/recipients/deleteAll?api_key=#{client.api_key}"
+      post_request(url, body: { delete_all: true })
+      true
+    rescue Stannp::Error => e
+      # Despite the request actually deleteing all recipients, the API returns a 400. In those
+      # cases, and when delete all is called on an empty recipient list, just return true.
+      return true if e.message == '400: Nothing to delete'
+
+      raise e
+    end
+  end
+end

data/lib/stannp/resources/user.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Stannp
+  class UserResource < Resource
+    def get
+      url = "https://dash.stannp.com/api/v1/users/me?api_key=#{client.api_key}"
+      User.new(get_request(url).body['data'])
+    end
+  end
+end

data/lib/stannp/version.rb

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

data/lib/stannp.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'stannp/version'
+
+module Stannp
+  autoload :Error, 'stannp/error'
+  autoload :Client, 'stannp/client'
+  autoload :Resource, 'stannp/resource'
+  autoload :Object, 'stannp/object'
+  autoload :List, 'stannp/list'
+  # resources
+  autoload :AccountResource, 'stannp/resources/account'
+  autoload :UserResource, 'stannp/resources/user'
+  autoload :RecipientsResource, 'stannp/resources/recipients'
+  # objects
+  autoload :User, 'stannp/objects/user'
+  autoload :Recipient, 'stannp/objects/recipient'
+end

data/sig/stannp.rbs

@@ -0,0 +1,4 @@
+module Stannp
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: stannp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- k-p-jones
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stannp.rb
+- lib/stannp/client.rb
+- lib/stannp/error.rb
+- lib/stannp/list.rb
+- lib/stannp/object.rb
+- lib/stannp/objects/recipient.rb
+- lib/stannp/objects/user.rb
+- lib/stannp/resource.rb
+- lib/stannp/resources/account.rb
+- lib/stannp/resources/recipients.rb
+- lib/stannp/resources/user.rb
+- lib/stannp/version.rb
+- sig/stannp.rbs
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A ruby wrapper for the Stannp direct mail API
+test_files: []