snap-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a50261392621d61f3d3f094c1a5692139021c057d2cab037212a856ab7a76a7d
+  data.tar.gz: dc538907ae6ad79ed9682f871046329b3943e7d628294c53895352e9ab011e5f
+SHA512:
+  metadata.gz: 38ff79ecb25b6583e2713de2d3181fb3e92e56c4f04111526158684f98fd42c24346444df5bfe4fa3ca4dc6c82d7ec1730bcb016001ee1c57f4c33da0df31a40
+  data.tar.gz: ca431ca5f8f145d58dd1235b1969a8d3fecf51bb17cd2e273fc5281bbb6473c21df2f635c3088545dabee0b2d4306888751a56e23a080ad428b1bdf3262577c0

data/.env.sample

@@ -0,0 +1,3 @@
+ENDPOINT='https://sample-api-endpoint'
+USERNAME='TEST'
+PASSWORD='ROGERS'

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+  Max: 100

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in snap.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 MeUndies
+
+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,51 @@
+# Snap
+
+A ruby gem to interact with the Snapfulfil API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby gem 'snap' ```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snap
+
+```ruby
+Snap.configure do |config|
+  config.endpoint = 'https://your-api-endpoint'
+  config.username = 'Fred'
+  config.password = 'Rogers'
+end
+```
+
+## 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).
+
+## Tests
+
+Once you've setup your environment you can run the tests with `rake spec`. In
+order to re-record VCR cassettes you'll want to make sure you have the following
+env var set as follows: `VCR=all`.
+
+## Contributing
+
+Bug reports and pull requests are welcome!

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dotenv/load'
+
+require 'snap'
+require_relative '../config/initializers/snap'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+cp -i .env.sample .env ||:
+cp -i .env.sample .env.test ||:

data/config/initializers/snap.rb

@@ -0,0 +1,5 @@
+Snap.configure do |config|
+  config.endpoint = ENV['ENDPOINT']
+  config.username = ENV['USERNAME']
+  config.password = ENV['PASSWORD']
+end

data/lib/snap/api/shipments.rb

@@ -0,0 +1,13 @@
+module Snap
+  module Api
+    # Interact with Snapfulfil's shipments endpoint.
+    class Shipments
+      include ::HTTParty
+      extend Client
+
+      def self.find(id:)
+        client.get("/shipments/#{id}")
+      end
+    end
+  end
+end

data/lib/snap/client.rb

@@ -0,0 +1,12 @@
+module Snap
+  # Encapsulates the configuration of each client before JIT before requests
+  # are made. This allows us to use our configuration which won't have been
+  # available until runtime, not load time.
+  module Client
+    def client
+      base_uri Snap.config.endpoint
+      basic_auth(Snap.config.username, Snap.config.password)
+      self
+    end
+  end
+end

data/lib/snap/version.rb

@@ -0,0 +1,3 @@
+module Snap
+  VERSION = '0.1.0'.freeze
+end

data/lib/snap.rb

@@ -0,0 +1,23 @@
+require 'httparty'
+
+require 'snap/version'
+require 'snap/client'
+
+require 'snap/api/shipments'
+
+# Top level module for the Snap gem.
+module Snap
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  # A simple configuration object to accept the required data to boot a client.
+  class Configuration
+    attr_accessor :endpoint, :username, :password
+  end
+end

data/snap.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snap-api'
+  spec.version       = Snap::VERSION
+  spec.authors       = ['Andrew Hood']
+  spec.email         = ['andrewhood125@gmail.com']
+
+  spec.summary       = 'Snap API Client'
+  spec.description   = 'Wraps the Cordial API for use inside Ruby applications.'
+  spec.homepage      = 'https://github.com/MeUndies/snap'
+
+  spec.license       = 'MIT'
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.16'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'dotenv', '~> 2.5'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.59'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: snap-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Hood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Wraps the Cordial API for use inside Ruby applications.
+email:
+- andrewhood125@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/initializers/snap.rb
+- lib/snap.rb
+- lib/snap/api/shipments.rb
+- lib/snap/client.rb
+- lib/snap/version.rb
+- snap.gemspec
+homepage: https://github.com/MeUndies/snap
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Snap API Client
+test_files: []