evvnt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fbf2109eb731d2fff7ed58d0bdfbdb870e9d858943e750d3851cc9f7e8c1fa8
+  data.tar.gz: 5ea6252bb8fcbda420fad16d663c617e72f206b986a7ea2c19644ab902dad15a
+SHA512:
+  metadata.gz: 291cd38c9c02deca7d0343a90de1025dac83a0314ac94a805ecd6c8758765b61fd4e07cd4e232aa71a4e3a48f704f349692e82358e22f560c1cb6e89d0b27469
+  data.tar.gz: 9c909e5592ded00962be89ff4e7ccec6a8d9666c5432ed53d513a9428b329aaf5bb63ff3da4dcff5cf7a0e5b8705bcaabab7488bb15259f78acb2d23d7cfb43d

data/.circleci/config.yml

@@ -0,0 +1,65 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.5
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/evvnt
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Bunder Audit
+          command: gem install bundle-audit && bundle-audit check --update
+
+      # run tests!
+      - run:
+          name: Run Rspec
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      - run:
+          name: Code Style Check
+          command: rubocop lib --display-style-guide -c ./.rubocop.yml
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+.ruby-version
+log
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--colour

data/.rubocop.yml

@@ -0,0 +1,61 @@
+AllCops:
+  UseCache: true
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.4
+  # Include:
+  Exclude:
+    - 'Gemfile'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - '**/Rakefile'
+    - '**/config.ru'
+
+StringLiterals:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false
+
+# Rails:
+#   Enabled: true
+
+Metrics/LineLength:
+  Max: 90
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false

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 evvnt.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    evvnt (0.1.0)
+      activesupport (>= 3.0)
+      httparty (>= 0.16.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_class (1.0.1)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    awesome_print (1.8.0)
+    byebug (10.0.0)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    dotenv (2.2.1)
+    hashdiff (0.3.7)
+    httparty (0.16.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    parallel (1.12.1)
+    parser (2.5.0.3)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    public_suffix (3.0.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-collection_matchers (1.1.3)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-json_matchers (0.1.0)
+      abstract_class (~> 1.0, >= 1.0.1)
+      awesome_print (~> 1.6)
+      rspec (~> 3.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  dotenv
+  evvnt!
+  rake (~> 10.0)
+  rspec
+  rspec-collection_matchers
+  rspec-json_matchers
+  rspec_junit_formatter
+  rubocop
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Bodacious
+
+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,88 @@
+# evvnt
+
+[![CircleCI](https://circleci.com/gh/KatanaCode/evvnt.svg?style=svg)](https://circleci.com/gh/KatanaCode/evvnt)
+
+Provides a Ruby wrapper around the evvnt APIs
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'evvnt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install evvnt
+
+## Usage
+
+Before you begin, you'll need to obtain an API key and secret from evvnt. Once you have that in place, include these in your gem configuration.
+
+### Configuration
+
+To configure the gem, create an initializer and define the following block:
+
+``` ruby
+# config/initializers/evvnt.rb
+Evvnt.configure do |config|
+  # Print out useful logger info to the Rails log
+  config.logger     = Rails.logger
+  config.debug      = Rails.env.development?
+  # Your API key and secret
+  config.api_key    = "..."
+  config.api_secret = "secret"
+end
+
+```
+
+### In your code
+
+This gem provides an equivalent endpoint for each of the endpoints on the evvnt API. It follows a familiar, idomatic rails pattern to create, fetch, and, update records.
+
+For example:
+
+```ruby
+# => Returns all of the categories from the API as an Evvnt::Category object
+@categories = Evvnt::Category.all
+
+# The same as the above, aliased
+@categories = Evvnt::Category.index
+
+# Returns the first Category
+@category = Evvnt::Category.first
+@category.name # => "Academic / Learning"
+
+# Returns the last Category
+@category = Evvnt::Category.last
+@category.name # => "Alternative Investment"
+
+# Create a User on the API
+@user = Evvnt::User.create(name: "Sarah Connor", email: "sarah@example.com")
+
+# Grab the last User from the API and update their email address:
+@user = Evvnt::User.last
+@user.email = "newemail@example.com"
+@user.save
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/katanacode/evvnt.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "dotenv"
+Dotenv.load
+
+require "evvnt"
+Evvnt.configure do |config|
+  config.api_key    = ENV["API_KEY"]
+  config.api_secret = ENV["API_SECRET"]
+  config.logger     = Logger.new(File.join("log", "development.log"))
+  config.debug      = true
+end
+
+# 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/evvnt.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "evvnt/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "evvnt"
+  spec.version       = Evvnt::VERSION
+  spec.authors       = ["Bodacious"]
+  spec.email         = ["bodacious@katanacode.com"]
+
+  spec.summary       = "A wrapper for the EVVNT API"
+  spec.description   = "Provides a wrapper and helper classes for the EVVNT rest API"
+  spec.homepage      = "https://github.com/katanacode.com/evvnt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec)/})
+  end
+  spec.require_paths = ["lib"]
+  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "httparty", ">= 0.16.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec-json_matchers"
+  spec.add_development_dependency "rspec-collection_matchers"
+end

data/lib/evvnt/actions.rb

@@ -0,0 +1,61 @@
+module Evvnt
+  # Internal: Methods for defining API actions for each resource Class.
+  #
+  module Actions
+    private
+
+      ##
+      # A list of the API actions defined on this class
+      #
+      # Returns Array
+      def defined_actions
+        @defined_actions ||= []
+      end
+
+      ##
+      # Define an action for this class to map on to the Evvnt API for this class's
+      # resource.
+      #
+      # action - A Symbol or String representing the action name. Should be one of the
+      #          template actions if block is not provided.
+      # block  - A Proc to be used as the action method definition when custom behaviour
+      #          is required.
+      #
+      # Examples
+      #
+      #   class Package < Evvnt::Base
+      #     # Define using the template `all` method
+      #     define_action :all
+      #     define_action :mine do
+      #       # define the custom behaviour here
+      #     end
+      #   end
+      #
+      # Returns Symbol
+      def define_action(action, &block)
+        action = action.to_sym
+        defined_actions << action unless defined_actions.include?(action)
+        if action.in?(Evvnt::ClassTemplateMethods.instance_methods)
+          define_class_action(action, &block)
+        end
+        if action.in?(Evvnt::InstanceTemplateMethods.instance_methods)
+          define_instance_action(action, &block)
+        end
+        action
+      end
+
+      # Define a class-level action on the current class. See {define_action}.
+      def define_class_action(action, &block)
+        body = block_given? ? block : ClassTemplateMethods.instance_method(action)
+        define_singleton_method(action, body)
+        singleton_class.send(:alias_method, :all, :index) if action == :index
+        singleton_class.send(:alias_method, :find, :show) if action == :show
+      end
+
+      # Define an instance-level action on the current class. See {define_action}.
+      def define_instance_action(action, &block)
+        body = block_given? ? block : InstanceTemplateMethods.instance_method(action)
+        define_method(action, body)
+      end
+  end
+end

data/lib/evvnt/api.rb

@@ -0,0 +1,108 @@
+module Evvnt
+  # Internal: Handles requests to the EVVNT api and catches their responses.
+  module Api
+    require "evvnt/api_error"
+
+    # frozen_string_literal: true
+    extend ActiveSupport::Concern
+
+    ##
+    # Allowed HTTP verbs
+    HTTP_VERBS = %i[get post put].freeze
+
+    # Class methods to define on {Evvnt::Base}
+    module ClassMethods
+      private
+
+        # Make a request of the EVVNT API.
+        #
+        # verb    - The HTTP verb for the request.
+        # path    - The path to request from the API.
+        # params  - A Hash of query params to send with the request.
+        # options - A Hash of additional options for the request.
+        #
+        # Returns HTTParty::Response
+        # Raises ArgumentError if the verb is not valid
+        def api_request(verb, path, params: {},  options: {})
+          unless verb.in?(HTTP_VERBS)
+            raise ArgumentError, "Unrecognised HTTP verb '#{verb}'"
+          end
+          path = sanitize_path(path)
+          log_request(verb, path, params)
+          response = public_send(verb, path, query: params, headers: headers)
+          log_response(response)
+          parse_response(response, options)
+        end
+
+        # Log the request being sent to the API
+        #
+        # verb   - A Symbol of the HTTP verb for the request
+        # path   - A String of the path of the request
+        # params - A Hash of the request params being sent to the server
+        #
+        def log_request(verb, path, params = {})
+          return unless Evvnt.configuration.debug
+          debug <<~TEXT
+            Headers: #{headers}")
+            Request: #{verb.to_s.upcase} #{base_uri}#{path} #{params}
+          TEXT
+        end
+
+        # Log the response from the API
+        #
+        # response - The Response object from the API
+        #
+        def log_response(response)
+          return unless Evvnt.configuration.debug
+          debug <<~TEXT
+            Response: #{response}
+            Status: #{response.code}
+          TEXT
+        end
+
+        ##
+        # Parse a response from the API and create objects from local classes.
+        #
+        # response - Response object from HTTParty request.
+        # options  - A Hash of options
+        #
+        # Returns Array
+        # Returns Evvnt::Base subclass
+        def parse_response(response, **options)
+          json = JSON.parse(response.body)
+          json = json[options[:object]] if options.key?(:object)
+          json.is_a?(Array) ? json.map { |a| new(a) } : new(json)
+        end
+
+        # Ensure the path is the correct format with a leading slash and ".json" extension
+        #
+        # path - A String with the API request path.
+        #
+        # Returns String
+        def sanitize_path(path)
+          path = "/"  + path    unless path.starts_with?('/')
+          path += ".json" unless path.ends_with?(".json")
+          path
+        end
+
+        ##
+        # Headers to be sent with every request.
+        #
+        # Returns Hash
+        def headers
+          {
+            "Authorization" => "Basic #{auth}",
+            "Content-Type"  => "application/json",
+            "Accept"        => "application/json"
+          }
+        end
+
+        ##
+        # Key and secret as Base64 string.
+        def auth
+          Base64.encode64([Evvnt.configuration.api_key,
+                           Evvnt.configuration.api_secret].join(":"))
+        end
+    end
+  end
+end

data/lib/evvnt/api_error.rb

@@ -0,0 +1,4 @@
+module Evvnt
+  class ApiError < StandardError
+  end
+end

data/lib/evvnt/audience_reach.rb

@@ -0,0 +1,4 @@
+module Evvnt
+  class AudienceReach < Evvnt::Base
+  end
+end