evvnt 0.1.0

data/lib/evvnt/path_helpers.rb

@@ -0,0 +1,114 @@
+module Evvnt
+  # Internal: Helper methods defining API paths for the defined resources
+  module PathHelpers
+    ##
+    # A regular expression to check for params in a URL String.
+    PARAM_REGEX = %r{\:[^\/$]+}
+
+    # Is this class defined as a singular resource?
+    #
+    # Returns Boolean
+    def singular_resource?
+      @singular_resource == true
+    end
+
+    # Declare this class as a singular resource
+    #
+    def singular_resource!
+      @singular_resource = true
+      resource_name(name.split("::").last.underscore.singularize)
+    end
+
+    # The name for this class's corresponding resource on the API.
+    #
+    # rename - A String representing the new resource_name.
+    #
+    def resource_name(rename = nil)
+      if rename
+        @resource_name = rename
+      else
+        @resource_name || default_resource_name
+      end
+    end
+
+    # Nest a given resource path within a parent resource.
+    #
+    # path   - A String representing an API resource path.
+    # params - A Hash of params to send to the API.
+    #
+    # Examples
+    #
+    #   nest_path_within_parent("bags/1", {user_id: "123"}) # => /users/123/bags/1
+    #
+    # Returns String
+    def nest_path_within_parent(path, params)
+      params.symbolize_keys!
+      parent_resource = parent_resource_name(params)
+      parent_id       = params.delete(parent_resource_param(params)).try(:to_s)
+      File.join(*[parent_resource, parent_id, path].compact).to_s
+    end
+
+    # The API path for a single resource on the API
+    #
+    # Returns String
+    def singular_resource_path
+      if singular_resource?
+        resource_name
+      else
+        "#{resource_name}/:id"
+      end
+    end
+
+    # The default name of this resource on the API (e.g. "users")
+    #
+    # Returns String
+    def default_resource_name
+      name.split("::").last.underscore.pluralize
+    end
+
+    # The defined path of this resource on the API (e.g. "/users")
+    #
+    # new_path - A String with the new default value for the plural_resource_path
+    # block    - A Proc object for defining dynamic resource_paths
+    #
+    # Returns String
+    # Returns Proc
+    def plural_resource_path(new_path = nil, &block)
+      if new_path || block_given?
+        @plural_resource_path = (new_path || block)
+      else
+        @plural_resource_path || default_resource_path
+      end
+    end
+
+    # The default path of this resource on the API (e.g. "/users")
+    #
+    # Returns String
+    def default_resource_path
+      resource_name
+    end
+
+    # Template method for fetching _mine_ records from the API.
+    #
+    # record_id - A String or Integer ID for the record we're fetching from the API.
+    # params    - A Hash of parameters to send to the API.
+    #
+    # Returns String
+    def singular_path_for_record(record_id, params)
+      if singular_resource_path.respond_to?(:call)
+        path = singular_resource_path.call
+        path.match(PARAM_REGEX) do |segment|
+          value = params.delete(segment.to_s[1..-1])
+          path  = path.gsub!(/#{segment}/, value.to_s)
+        end
+      else
+        path = singular_resource_path
+      end
+      path = path.gsub(/\:id/, record_id.to_s)
+      if params_include_parent_resource_id?(params)
+        path = nest_path_within_parent(path, params)
+      end
+      path
+    end
+  end
+end

data/lib/evvnt/persistence.rb

@@ -0,0 +1,41 @@
+module Evvnt
+  # Provides methods for saving an individual record to the API
+  module Persistence
+    # Has this record been saved on the EVVNT API?
+    #
+    # Returns a Boolean
+    def persisted?
+      unique_identifier.present?
+    end
+
+    # Is this record an unsaved/fresh record?
+    #
+    # Returns a Boolean
+    def new_record?
+      unique_identifier.blank?
+    end
+
+    # Save this record to the EVVNT API
+    #
+    # Returns {Evvnt::Base} subclass
+    def save
+      new_record? ? save_as_new_record : save_as_persisted_record
+    end
+
+    private
+
+    # Save this record to the EVVNT API as a new record using the +create+ action.
+    #
+    def save_as_new_record
+      new_attributes = attributes.reject { |k, _v| k.to_s =~ /^(id|uuid)$/ }
+      self.class.create(new_attributes)
+    end
+
+    # Save this record to the EVVNT API as an existing record using the +update+ action.
+    #
+    def save_as_persisted_record
+      new_attributes = attributes.reject { |k, _v| k.to_s =~ /^(id|uuid)$/ }
+      self.class.update(id, new_attributes)
+    end
+  end
+end

data/lib/evvnt/price.rb

@@ -0,0 +1,5 @@
+module Evvnt
+  class Price < Evvnt::Base
+
+  end
+end

data/lib/evvnt/published_event.rb

@@ -0,0 +1,21 @@
+module Evvnt
+  # Public: Represents published {Evvnt::Event Events} on the EVVNT API
+  class PublishedEvent < Evvnt::Base
+
+    ##
+    # GET /events List Events
+    define_action :index
+
+    ##
+    # GET /events/:event_id Get one event
+    define_action :show
+
+    ##
+    # PUT /events/:event_id Update an event
+    define_action :update
+
+
+    belongs_to :publisher
+
+  end
+end

data/lib/evvnt/publisher.rb

@@ -0,0 +1,11 @@
+module Evvnt
+  # Public: Returns list of publishers from the EVVNT API.
+  #
+  class Publisher < Evvnt::Base
+
+    ##
+    # GET /publishers List my publishing sites
+    define_action :index
+
+  end
+end

data/lib/evvnt/referrer.rb

@@ -0,0 +1,5 @@
+module Evvnt
+  class Referrer < Evvnt::Base
+
+  end
+end

data/lib/evvnt/report.rb

@@ -0,0 +1,58 @@
+module Evvnt
+  # Public: Returns report for a given {Evvnt::Event} from the API.
+  #
+  # Examples
+  #
+  #   Evvnt::Report.find(event_id: '...')
+  #
+  class Report < Evvnt::Base
+
+    singular_resource!
+
+    belongs_to :event
+
+    ##
+    # GET /events/:event_id/report View report data for my event
+    define_action :show
+
+    private
+
+    def format_hash_attribute(key, value)
+      case key
+      when /^(referrers|search\_indexing)$/
+        send(:"format_#{key}_attribute", key, value)
+      else
+        super
+      end
+    end
+
+    def format_array_attribute(key, value)
+      case key
+      when /^(clicks\_by\_day|broadcasts)$/
+        send(:"format_#{key}_attribute", key, value)
+      else
+        super
+      end
+    end
+
+    def format_referrers_attribute(_key, value)
+      value.to_a.map { |url, count| Evvnt::Referrer.new(url: url, count: count) }
+    end
+
+    def format_search_indexing_attribute(_key, value)
+      value.to_a.map { |name, url| Evvnt::SearchIndexing.new(name: name, url: url) }
+    end
+
+    def format_broadcasts_attribute(_key, value)
+      Array(value).map { |atts| Evvnt::Broadcast.new(atts) }
+    end
+
+    def format_clicks_by_day_attribute(_key, value)
+      value.to_a[1..-1].map do |date, twitter, myspace, total|
+        Evvnt::ClicksByDay.new(date: date, twitter: twitter,
+                               myspace: myspace, total: total)
+      end
+    end
+
+  end
+end

data/lib/evvnt/search_indexing.rb

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

data/lib/evvnt/user.rb

@@ -0,0 +1,24 @@
+module Evvnt
+  # Fetch EVVNT Users from the API
+  class User < Evvnt::Base
+
+    ##
+    # POST /users Create a user
+    define_action :create
+
+
+    ##
+    # GET /users Get a list of all users created by you
+    define_action :index
+
+    ##
+    # GET /users/:user_id Get details of a user
+    define_action :show
+
+
+    ##
+    # PUT /users/:user_id Update a user
+    define_action :update
+
+  end
+end

data/lib/evvnt/venue.rb

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

data/lib/evvnt/version.rb

@@ -0,0 +1,3 @@
+module Evvnt
+  VERSION = "0.1.0".freeze
+end

data/lib/evvnt.rb

@@ -0,0 +1,46 @@
+require "active_support/core_ext/object/inclusion"
+require "active_support/configurable"
+require "active_support/concern"
+require "active_support/core_ext/string"
+require "active_support/core_ext/hash"
+require "active_support/hash_with_indifferent_access"
+
+require 'logger'
+require 'httparty'
+require "evvnt/version"
+require "evvnt/configuration"
+
+# Master module for Evvnt functionality.
+module Evvnt
+  # frozen_string_literal: true
+
+  module_function
+
+  def configure(&block)
+    @configuration = Evvnt::Configuration.new(&block)
+  end
+
+  def configuration
+    @configuration ||= configure
+  end
+
+  require "evvnt/base"
+  require "evvnt/audience_reach"
+  require "evvnt/broadcast"
+  require "evvnt/broadcast_result"
+  require "evvnt/category"
+  require "evvnt/clicks_by_day"
+  require "evvnt/contact"
+  require "evvnt/contract"
+  require "evvnt/event"
+  require "evvnt/link"
+  require "evvnt/package"
+  require "evvnt/price"
+  require "evvnt/published_event"
+  require "evvnt/publisher"
+  require "evvnt/referrer"
+  require "evvnt/report"
+  require "evvnt/search_indexing"
+  require "evvnt/user"
+  require "evvnt/venue"
+end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: evvnt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matchers
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  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: Provides a wrapper and helper classes for the EVVNT rest API
+email:
+- bodacious@katanacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- evvnt.gemspec
+- lib/evvnt.rb
+- lib/evvnt/actions.rb
+- lib/evvnt/api.rb
+- lib/evvnt/api_error.rb
+- lib/evvnt/audience_reach.rb
+- lib/evvnt/base.rb
+- lib/evvnt/broadcast.rb
+- lib/evvnt/broadcast_result.rb
+- lib/evvnt/category.rb
+- lib/evvnt/class_template_methods.rb
+- lib/evvnt/clicks_by_day.rb
+- lib/evvnt/configuration.rb
+- lib/evvnt/contact.rb
+- lib/evvnt/contract.rb
+- lib/evvnt/event.rb
+- lib/evvnt/instance_template_methods.rb
+- lib/evvnt/link.rb
+- lib/evvnt/logging.rb
+- lib/evvnt/nested_resources.rb
+- lib/evvnt/package.rb
+- lib/evvnt/path_helpers.rb
+- lib/evvnt/persistence.rb
+- lib/evvnt/price.rb
+- lib/evvnt/published_event.rb
+- lib/evvnt/publisher.rb
+- lib/evvnt/referrer.rb
+- lib/evvnt/report.rb
+- lib/evvnt/search_indexing.rb
+- lib/evvnt/user.rb
+- lib/evvnt/venue.rb
+- lib/evvnt/version.rb
+homepage: https://github.com/katanacode.com/evvnt
+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.3
+signing_key: 
+specification_version: 4
+summary: A wrapper for the EVVNT API
+test_files: []