ramco 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ba4d5cfa71ff453203b64fe47e5f1e9f0605cab61d0ac030aeab022c69d1088
+  data.tar.gz: 11f3cb4d1d4a2530a3dfda0e136c74bd53d4521a676b6953314550965e494192
+SHA512:
+  metadata.gz: 98269f7726e4f61ca5f09cf547686bcbc53673d6f25b0225d51d02c7a2e5f24fab5cff9c2d34641805ac6acd166048d9d85f1a8f3c98290a48f55231bfa14795
+  data.tar.gz: '0808430731bbbe0c6a64453be274d0f57c444770b6718a8c9a8d0978be818f3c32349e7aa076f66b53c47ff8aefdf1ad710aa1e1ad7f67fbfb48b818f9395446'

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kurt@connectspaceinc.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kurt Kowitz
+
+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,128 @@
+# Ramco Ruby
+
+This is an unofficial ruby client for the [RAMCOAMS API](https://api.ramcoams.com/api/v2/ramco_api_v2_doc.pdf).  The end goal is a complete, intuitive and simple ruby API for working with the RAMCOAMS API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ramco'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ramco
+
+# Usage
+
+Instantiate the client using a provided RAMCOAMS API key:
+  
+    ramco = Ramco.api_key("api_key")
+
+## GetEntity
+
+Fetch the attributes and/or relationships of one specific entity using guid.
+
+    ramco.get_entity({"entity" => "Contact", "guid" => "6868642f-0144-e811-9c17-00155d10120d", "attributes" => "ContactId,FirstName,LastName"})
+
+ * post params
+    * Entity = Type of entity being queried (ex: Contact)
+    * Guid = guid of entity to return
+    * Attributes = comma separated list of attributes to return
+    
+## GetEntities
+
+Fetch the attributes and/or relationships of multiple entities of one type using a user-defined filter.
+
+    ramco.get_entities({"entity" => "Contact", "attributes" => "ContactId,FirstName,LastName", "maxresults" => "5"})
+
+ * post params
+    * Entity = Name of entity being queried (ex: Contact)
+    * Filter (optional) = User-specified filter string
+    * Attributes = comma separated list of attributes to return
+    * StringDelimiter (optional) = User-specified delimiter used to wrap string values (default is #)
+    * MaxResults (optional) = Maximum number of entities to return
+    
+## GetEntityMetadata
+
+Fetch metadata on entity type Contact (includes entity description, attributes and relationships).
+
+    ramco.get_entity_metadata({"entity" => "Contact"})
+
+## GetEntityTypes
+
+Fetch all entities in the system.
+
+    ramco.get_entity_types
+
+## GetOptionSet
+
+Fetch the valid value/label pairs for the specified OptionSet (what Ramco calls a picklist)
+
+    ramco.get_option_set({"entity" => "Contact", "attribute" => "PreferredPhone"})
+
+  * post params
+    * Entity = Name of entity being queried (ex: Contact)
+    * Attribute= Name of the attribute being queried (ex: PreferredPhone)
+
+## ValidateUser
+
+Returns the globally unique id of a contact that matches the provided cobalt_username and cobalt_password parameters. Returns a 422 error when there is no user with provided username/password combination.
+
+    ramco.validate_user({"cobalt_username" => "username", "cobalt_password" => "password"})
+  
+  * Post params:
+    * cobalt_username = User’s username
+    * cobalt_password = User’s password
+
+## ClearCache
+
+Clears the server-side metadata cache. If an entity or attribute has been added (or removed), then clearing the cache will permit the changes to be reflected immediately. The cache will normally expire every 24 hours.
+
+    ramco.clear_cache
+
+# Testing
+
+The test suite uses [VCR](https://github.com/myronmarston/vcr) to cache actual requests to the RAMCO API in a directory called responses in the spec directory.
+
+In order for VCR to make and cache the actual calls to the RAMCO API you will need to copy spec/settings.yml.sample to spec/settings.yml and configure it with your RAMCO key or add RAMCO_KEY as an environment variable.
+
+This file is ignored by git (see .gitignore) so you can commit any changes you make to the gem without having to worry about your key being released into the wild.
+
+Now run the test suite:
+
+    bundle
+    bundle exec rake api
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/message-blocks/ramco-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+If you'd like to hack on Ramco-ruby, start by forking the repo on GitHub:
+
+https://github.com/message-blocks/ramco-ruby
+
+The best way to get your changes merged back into core is as follows:
+
+1. Clone down your fork
+1. Create a thoughtfully named topic branch to contain your change
+1. Hack away
+1. Add tests and make sure everything still passes by running `bundle exec rake`
+1. If you are adding new functionality, document it in the README
+1. Do not change the version number, we will do that on our end
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send a pull request for your branch
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ramco Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ramco/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run the specs"
+RSpec::Core::RakeTask.new do |t|
+  #t.rspec_opts = %w(-fs --color)
+end
+
+task :default => :spec
+task :test => :spec
+
+desc "Run the api specs"
+RSpec::Core::RakeTask.new do |t|
+  t.name = :api
+  t.pattern = "spec/ramco/api/*_spec.rb"
+end
+
+desc "Open an irb session with library"
+task :console do 
+  sh "irb -I lib -r ramco"
+end
+
+desc "clean out VCR responses"
+task :clean do
+  sh "rm -rf spec/responses"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ramco"
+
+# 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/ramco/api/clear_cache.rb

@@ -0,0 +1,18 @@
+class Ramco
+  module API
+    module ClearCache
+
+      # ClearCache
+      # Clears the server-side metadata cache. If an entity or attribute has been added (or removed),
+      # then clearing the cache will permit the changes to be reflected immediately. 
+      # The cache will normally expire every 24 hours.
+      #
+      # Returns json
+      #
+      def clear_cache(params={})
+        params['operation'] = "ClearCache"
+        request(connection, params)
+      end
+    end
+  end
+end

data/lib/ramco/api/entities.rb

@@ -0,0 +1,24 @@
+class Ramco
+  module API
+    module Entities
+      
+      # Get entities
+      # Fetch the attributes and/or relationships of multiple entities of one type using a user-defined filter.
+      #
+      # Entity = Name of entity being queried (ex: Contact)
+      # Filter (optional) = User-specified filter string
+      # Attributes = comma separated list of attributes to return
+      # StringDelimiter (optional) = User-specified delimiter used to wrap string values (default is #)
+      # MaxResults (optional) = Maximum number of entities to return
+      #
+      # {"entity" => "Contact", "attributes" => "ContactId,FirstName,LastName", "maxresults" => "5"}
+      #
+      # Returns json
+      #
+      def get_entities(params={})
+        params['operation'] = "GetEntities"
+        request(connection, params)
+      end
+    end
+  end
+end

data/lib/ramco/api/entity.rb

@@ -0,0 +1,22 @@
+class Ramco
+  module API
+    module Entity
+
+      # GetEntity
+      # Fetch the attributes and/or relationships of one specific entity using guid.
+      #
+      # Entity = Type of entity being queried (ex: Contact)
+      # Guid = guid of entity to return
+      # Attributes = comma separated list of attributes to return
+      #
+      # {"entity" => "Contact", "guid" => "6868642f-0144-e811-9c17-00155d10120d", "attributes" => "ContactId,FirstName,LastName"}
+      #
+      # Returns json
+      #
+      def get_entity(params={})
+        params['operation'] = "GetEntity"
+        request(connection, params)
+      end
+    end
+  end
+end

data/lib/ramco/api/entity_metadata.rb

@@ -0,0 +1,19 @@
+class Ramco
+  module API
+    module EntityMetadata
+      
+      # GetEntityMetadata
+      # Fetch metadata on entity type, including entity description, attributes and relationships
+      # Entity = Name of entity being queried, for example: Contact
+      #
+      # {"entity" => "Contact"}
+      #
+      # Returns json
+      #
+      def get_entity_metadata(params={})
+        params['operation'] = "GetEntityMetadata"
+        request(connection, params)
+      end
+    end
+  end
+end

data/lib/ramco/api/entity_types.rb

@@ -0,0 +1,16 @@
+class Ramco
+  module API
+    module EntityTypes
+      
+      # GetEntityTypes
+      # Returns a complete list of all entities in the system
+      #
+      # Returns json
+      #
+      def get_entity_types(params={})
+        params['operation'] = "GetEntityTypes"
+        request(connection, params)
+      end
+    end
+  end
+end

data/lib/ramco/api/option_set.rb

@@ -0,0 +1,21 @@
+class Ramco
+  module API
+    module OptionSet
+
+      # GetOptionSet
+      # Fetch the valid value/label pairs for the specified OptionSet (what Ramco calls a picklist)
+      #
+      # Entity = Name of entity being queried (ex: Contact)
+      # Attribute = Name of the attribute being queried (ex: PreferredPhone)
+      #
+      # {"entity" => "Contact", "attribute" => "PreferredPhone"}
+      #
+      # Returns json
+      #
+      def get_option_set(params={})
+        params['operation'] = "GetOptionSet"
+        request(connection, params)
+      end
+    end
+  end
+end

data/lib/ramco/api/validate_user.rb

@@ -0,0 +1,24 @@
+class Ramco
+  module API
+    module ValidateUser
+      
+      # ValidateUser
+      # Returns the globally unique id of a contact that matches the provided 
+      # cobalt_username and cobalt_password parameters. 
+      # 
+      # Returns a 422 error when there is no user with provided username/password combination.
+      #
+      # cobalt_username = User's username
+      # cobalt_password = User's password
+      #
+      # {"cobalt_username" => "username", "cobalt_password" => "password"}
+      #
+      # Returns json
+      #
+      def validate_user(params={})
+        params['operation'] = "ValidateUser"
+        request(connection, params)
+      end
+    end
+  end
+end

data/lib/ramco/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'multi_json'
+
+class Ramco
+  class Connection < Faraday::Connection
+    attr_reader :hash, :api_key
+
+    # Instantiates connection, accepts an options hash
+    # for authenticated access
+    #
+    # Ramco expects
+    #   :key => "API Key"
+    
+    def initialize(hash={})
+      @hash = hash
+      @api_key = hash[:api_key] if hash.has_key? :api_key
+
+      super(hash[:api_url] || 'https://api.ramcoams.com/api/v2/') do |builder|
+        yield builder if block_given?
+        builder.use     Faraday::Response::RaiseRamcoError
+        builder.use     FaradayMiddleware::EncodeJson
+        builder.use     FaradayMiddleware::ParseJson
+        builder.adapter :typhoeus
+      end
+    end
+  end
+end

data/lib/ramco/errors.rb

@@ -0,0 +1,77 @@
+require 'json/ext'
+require 'multi_json'
+
+class Ramco
+  # Custom error class for rescuing from all Ramco errors
+  class Error < StandardError
+    def initialize(response=nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    def response_body
+      @response_body ||= if (body = @response[:body]) && !body.empty?
+        if false and body.is_a?(String)
+          MultiJson.load(body, :symbolize_keys => true)
+        else
+          body
+        end
+      else
+        nil
+      end
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil?
+
+      message = if response_body
+        "#{response_body["ResponseCode"]}: #{response_body["ResponseText"]}"
+      else
+        ''
+      end
+
+      "#{message}"
+    end
+  end
+
+  # Raised when Ramco returns a 400 HTTP status code
+  class BadRequest < Error; end
+
+  # Raised when Ramco returns a 401 HTTP status code
+  class Unauthorized < Error; end
+
+  # Raised when Ramco returns a 404 HTTP status code
+  class NotFound < Error; end
+
+  # Raised when Ramco returns a 422 HTTP status code
+  class InvalidUser < Error; end
+
+  # Raised when Ramco returns a 500 HTTP status code
+  class InternalServerError < Error; end
+
+  # Raised when Ramco returns a 502 HTTP status code
+  class BadGateway < Error; end
+
+  # Raised when Ramco returns a 503 HTTP status code
+  class ServiceUnavailable < Error; end
+end
+
+module Faraday
+  class Response::RaiseRamcoError < Response::Middleware
+    ERROR_MAP = {
+      400 => Ramco::BadRequest,
+      401 => Ramco::Unauthorized,
+      422 => Ramco::InvalidUser,
+      500 => Ramco::InternalServerError,
+      502 => Ramco::BadGateway,
+      503 => Ramco::ServiceUnavailable
+    }
+
+    def on_complete(response)
+      key = response.body["ResponseCode"].to_i
+      raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
+    end
+  end
+end

data/lib/ramco/version.rb

@@ -0,0 +1,3 @@
+class Ramco
+  VERSION = "0.1.1"
+end

data/lib/ramco.rb

@@ -0,0 +1,44 @@
+require 'ramco/version'
+require 'ramco/connection'
+require 'ramco/errors'
+require 'ramco/api/clear_cache'
+require 'ramco/api/entities'
+require 'ramco/api/entity_metadata'
+require 'ramco/api/entity_types'
+require 'ramco/api/entity'
+require 'ramco/api/option_set'
+require 'ramco/api/validate_user'
+
+class Ramco
+  attr_reader :connection
+  
+  include Ramco::API::ClearCache
+  include Ramco::API::Entities
+  include Ramco::API::EntityMetadata
+  include Ramco::API::EntityTypes
+  include Ramco::API::Entity
+  include Ramco::API::OptionSet
+  include Ramco::API::ValidateUser
+  
+
+  def initialize(options = {}, &block)
+    @options = options
+    @block = block if block
+    return @connection = Ramco::Connection.new(options, &block) 
+  end
+  
+  def self.api_key(api_key, api_url = nil)
+    options = {:api_key => api_key}
+    options[:api_url] = api_url if api_url
+    Ramco.new  options
+  end
+    
+  private
+  
+  def request(connection, params)
+    connection.post do |req|
+      req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+      req.body = params.merge({"key" => connection.api_key})
+    end.body["Data"]
+  end
+end

data/ramco.gemspec

@@ -0,0 +1,33 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "ramco/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ramco"
+  spec.version       = Ramco::VERSION
+  spec.required_ruby_version = ">= 2.4.6"
+  spec.authors       = ["Kurt Kowitz"]
+  spec.email         = ["kurt@connectspaceinc.com"]
+
+  spec.summary       = %q{Access RAMCOAMS in ruby.}
+  spec.description   = %q{A simple ruby API for accessing RAMCOAMS.}
+  spec.homepage      = "https://github.com/message-blocks/ramco"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_dependency 'multi_json', '~> 1.3'
+  spec.add_dependency 'typhoeus', '~> 0.7.0'
+  
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~>3.0'
+  spec.add_development_dependency 'json_pure'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'pry-byebug'
+end

data/spec/ramco/api/clear_cache_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Ramco::API::ClearCache do
+  subject { Ramco.api_key(RAMCO_KEY) }
+
+  describe "#clear_cache" do
+    it "should clear cache" do
+      VCR.use_cassette('clear cache') do
+        response = subject.clear_cache
+        expect(response).to be_nil
+      end
+    end
+  end
+end

data/spec/ramco/api/entities_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Ramco::API::Entities do
+  subject { Ramco.api_key(RAMCO_KEY) }
+
+  describe "#get_entities" do
+    it "should get entities" do
+      VCR.use_cassette('get entities') do
+        response = subject.get_entities({"entity" => "Contact", "attributes" => "ContactId,FirstName,LastName", "maxresults" => "2"})
+        expect(response.length).to eq(2)
+        expect(response[0]).to have_key "ContactId"
+      end
+    end
+  end
+end

data/spec/ramco/api/entity_metadata_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Ramco::API::EntityMetadata do
+  subject { Ramco.api_key(RAMCO_KEY) }
+
+  describe "#get_entity_metadata" do
+    it "should get entity metadata" do
+      VCR.use_cassette('get entity metadata') do
+        response = subject.get_entity_metadata({"entity" => "Contact"})
+        expect(response).to be_instance_of(Hash)
+        expect(response).to have_key "Name"
+        expect(response["Name"]).to eq("Contact")
+        expect(response).to have_key "PrimaryIdAttribute"
+        expect(response["PrimaryIdAttribute"]).to eq("ContactId")        
+      end
+    end
+  end
+end

data/spec/ramco/api/entity_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Ramco::API::Entity do
+  subject { Ramco.api_key(RAMCO_KEY) }
+
+  describe "#get_entity" do
+    it "should get entity" do
+      VCR.use_cassette('get entity') do
+        response = subject.get_entity({"entity" => "Contact", "guid" => "6868642f-0144-e811-9c17-00155d10120d", "attributes" => "ContactId,FirstName,LastName"})
+        expect(response).to be_instance_of(Hash)  
+        expect(response).to have_key "ContactId"
+        expect(response["ContactId"]).to eq("6868642f-0144-e811-9c17-00155d10120d")
+      end
+    end
+  end
+end

data/spec/ramco/api/entity_types_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Ramco::API::EntityTypes do
+  subject { Ramco.api_key(RAMCO_KEY) }
+
+  describe "#get_entity_types" do
+    it "should get entity types" do
+      VCR.use_cassette('get entity types') do
+        response = subject.get_entity_types
+        expect(response).to be_instance_of(Hash)  
+        expect(response).to have_key "contact"
+      end
+    end
+  end
+end

data/spec/ramco/connection_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Ramco::Connection do
+  context "with an api_token" do
+    subject { Ramco::Connection.new({api_key: RAMCO_KEY}) }
+
+    describe "#initialize" do
+      it "should set an instance variable for api key" do
+        expect(subject.hash).to eq({api_key: RAMCO_KEY})
+        expect(subject.api_key).to eq(RAMCO_KEY)
+      end
+    end
+
+    describe "a valid authorized request" do
+      let(:response) do
+        VCR.use_cassette('authorized_request') do
+          subject.post do |req|
+            req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+            req.body = {"key" => subject.api_key, "operation" => "GetEntity", "entity" => "Contact", "guid" => "6868642f-0144-e811-9c17-00155d10120d", "attributes" => "ContactId,FirstName,LastName"}
+          end
+        end
+      end
+
+      it "should return 200" do
+        expect(response.status).to eq(200)
+      end
+
+      it "should parse the json response" do
+        expect(response.body).to_not be_nil
+      end
+    end
+  end
+
+  context "without an api key" do
+    subject { Ramco::Connection.new }
+
+    describe "#initialize" do
+      it "should not set an instance variable for api key" do
+        expect(subject.hash).to eq({})
+      end
+    end
+
+    describe "any request" do
+      let(:response) do
+        VCR.use_cassette('unauthorized_request') do
+          subject.post
+        end
+      end
+      it "should raise error" do
+        expect {response}.to raise_error(Ramco::BadRequest)
+      end
+    end
+  end
+end

data/spec/ramco_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Ramco do
+  it "should have a VERSION constant" do
+    expect(Ramco.const_defined?('VERSION')).to be_truthy
+  end
+
+  describe "factory methods" do 
+    context "with api key" do
+      it "should set up a connection" do 
+        rc = Ramco.api_key "ABC123"
+        expect(rc.connection).to be_instance_of(Ramco::Connection)
+        expect(rc.connection.hash).to eq({api_key: "ABC123"})
+      end
+    end
+  end
+  describe "#initialize" do
+    context "with an api key" do
+      it "should set up a connection" do
+        rc = Ramco.new({api_key: "ABC123"})
+        expect(rc.connection).to be_instance_of(Ramco::Connection)
+        expect(rc.connection.hash).to eq({api_key: "ABC123"})
+        expect(rc.connection.api_key).to eq("ABC123")
+      end
+    end
+
+    context "without an access_token" do
+      it "should set up a connection" do
+        rc = Ramco.new
+        expect(rc.connection).to be_instance_of(Ramco::Connection)
+      end
+    end
+  end
+end

data/spec/settings.yml.sample

@@ -0,0 +1 @@
+api_key: your_ramco_api_key

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'bundler'
+Bundler.require :default, :test
+require 'webmock/rspec'
+require 'vcr'
+require 'ramco'
+require 'pry'
+
+VCR.configure do |c|
+  c.cassette_library_dir = File.expand_path('../responses', __FILE__)
+  c.hook_into :webmock
+  c.default_cassette_options = {:record => :once}
+  c.allow_http_connections_when_no_cassette = true
+end
+if File.exists? File.expand_path("../settings.yml", __FILE__)
+  settings = YAML.load_file(File.expand_path('../settings.yml', __FILE__))
+  RAMCO_KEY = settings['api_key']
+else
+  RAMCO_KEY = ENV["RAMCO_KEY"]
+end
+class Guid
+  def self.guid
+    UUIDTools::UUID.timestamp_create().to_s
+  end
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: ramco
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kurt Kowitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+  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: json_pure
+  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: vcr
+  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: pry-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'
+description: A simple ruby API for accessing RAMCOAMS.
+email:
+- kurt@connectspaceinc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ramco.rb
+- lib/ramco/api/clear_cache.rb
+- lib/ramco/api/entities.rb
+- lib/ramco/api/entity.rb
+- lib/ramco/api/entity_metadata.rb
+- lib/ramco/api/entity_types.rb
+- lib/ramco/api/option_set.rb
+- lib/ramco/api/validate_user.rb
+- lib/ramco/connection.rb
+- lib/ramco/errors.rb
+- lib/ramco/version.rb
+- ramco.gemspec
+- spec/ramco/api/clear_cache_spec.rb
+- spec/ramco/api/entities_spec.rb
+- spec/ramco/api/entity_metadata_spec.rb
+- spec/ramco/api/entity_spec.rb
+- spec/ramco/api/entity_types_spec.rb
+- spec/ramco/connection_spec.rb
+- spec/ramco_spec.rb
+- spec/settings.yml.sample
+- spec/spec_helper.rb
+homepage: https://github.com/message-blocks/ramco
+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.4.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Access RAMCOAMS in ruby.
+test_files:
+- spec/ramco/api/clear_cache_spec.rb
+- spec/ramco/api/entities_spec.rb
+- spec/ramco/api/entity_metadata_spec.rb
+- spec/ramco/api/entity_spec.rb
+- spec/ramco/api/entity_types_spec.rb
+- spec/ramco/connection_spec.rb
+- spec/ramco_spec.rb
+- spec/settings.yml.sample
+- spec/spec_helper.rb