fub_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 315cc504513f58a683db315daaa20e2ed4dff69a
+  data.tar.gz: 12b2610af24a05026ca8a92ce3c9ecab9d4668db
+SHA512:
+  metadata.gz: 892188adcfcc9e85beb97413fc9b2ff7bac43c9ef5f2140950b85ab4649c9e3b6bf4f9e00f56d21471568cda18835c9828ecdd7e5b14e699d2a3aa94e94ebd99
+  data.tar.gz: d1fcbeda8485b06e8b480c02e5cdaac253685d46b7d141ee4a1807cd6aa6286d6f8d1b5451c42ca5ad6595b7c0e05e6bb90cf099e36b53a50ecae866db443e3a

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+# C9
+.c9
+# RubyMine
+.idea
+# Env
+.env
+# VCR
+/spec/cassettes

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+fub_client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kopz9999@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fub_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kyoto Kopz
+
+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,66 @@
+# FubClient
+
+This gem is a Ruby Client for [Follow Up Boss API](https://api.followupboss.com/api-documentation/)
+For more information about Follow Up Boss go to [www.followupboss.com](www.followupboss.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fub_client', '0.1.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fub_client
+
+## Usage
+
+After installing the gem, you can start consuming FUB resources as Rails like 
+models with shorthand methods based on [Her](https://github.com/remiprev/her) 
+models:
+
+```ruby
+# Get one event 
+event = FubClient::Event.find 12
+
+# Paginate (offset calculated)
+persons = FubClient::Person.by_page 2, 10
+# => Her::Model::Relation<Person>
+
+# Total (from all records)
+total = FubClient::EmailTemplate.total
+# => 323
+```
+
+Put your API key in an environment variable named FUB_API_KEY:
+```bash
+$ export FUB_API_KEY=your_key
+```
+
+Or set it up via the client instance:
+
+```ruby
+FubClient::Client.instance.api_key = 'your_key'
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fub_client. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fub_client"
+
+# 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

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/fub_client.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fub_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fub_client"
+  spec.version       = FubClient::VERSION
+  spec.authors       = ["Kyoto Kopz"]
+  spec.email         = ["kopz9999@gmail.com"]
+
+  spec.summary       = 'Ruby client for Follow Up Boss API http://www.followupboss.com'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/kopz9999/fub_client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "her", "~> 0.8.1"
+  spec.add_dependency "faraday", ">= 0.8", '<= 0.9.2'
+  spec.add_dependency "facets", '>= 3.0.0'
+
+  # Developemnt
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv", '>= 2.1.1'
+  spec.add_development_dependency "vcr", '>= 3.0.3'
+  spec.add_development_dependency "webmock", '>= 2.1.0'
+  spec.add_development_dependency "pry", ">= 0.10.3"
+end

data/lib/fub_client.rb

@@ -0,0 +1,29 @@
+# Libs
+require 'base64'
+require 'singleton'
+require 'faraday'
+require 'her'
+require 'facets/string/snakecase'
+
+# App
+require "fub_client/version"
+require "fub_client/client"
+require "fub_client/middleware"
+require "fub_client/resource"
+# App Models
+require "fub_client/event"
+require "fub_client/person"
+require "fub_client/note"
+require "fub_client/call"
+require "fub_client/user"
+require "fub_client/smart_list"
+require "fub_client/email_template"
+require "fub_client/action_plan"
+require "fub_client/em_event"
+require "fub_client/custom_field"
+
+module FubClient
+  def self.root
+    File.expand_path '../..', __FILE__
+  end  
+end

data/lib/fub_client/action_plan.rb

@@ -0,0 +1,5 @@
+module FubClient
+  class ActionPlan < Resource
+    collection_path 'actionPlans'
+  end
+end

data/lib/fub_client/call.rb

@@ -0,0 +1,4 @@
+module FubClient
+  class Call < Resource
+  end
+end

data/lib/fub_client/client.rb

@@ -0,0 +1,40 @@
+module FubClient
+  class Client
+    API_URL = 'api.followupboss.com'
+    API_VERSION = 'v1'
+    
+    include Singleton
+    
+    attr_writer :api_key
+    attr_reader :her_api
+    
+    def initialize
+      init_her_api
+    end
+    
+    def api_key
+      @api_key ||= ENV['FUB_API_KEY']
+    end
+
+    def api_uri
+      @api_uri ||= URI::HTTPS.build(host: API_URL, path: "/#{API_VERSION}")
+    end
+    
+    private
+    
+    def init_her_api
+      @her_api = Her::API.new
+      @her_api.setup url: self.api_uri.to_s do |c|
+        # Request
+        c.use FubClient::Middleware::Authentication
+        c.use Faraday::Request::UrlEncoded
+      
+        # Response
+        c.use FubClient::Middleware::Parser
+      
+        # Adapter
+        c.use Faraday::Adapter::NetHttp
+      end
+    end
+  end
+end

data/lib/fub_client/custom_field.rb

@@ -0,0 +1,5 @@
+module FubClient
+  class CustomField < Resource
+    collection_path 'customFields'
+  end
+end

data/lib/fub_client/em_event.rb

@@ -0,0 +1,5 @@
+module FubClient
+  class EmEvent < Resource
+    collection_path 'emEvents'
+  end
+end

data/lib/fub_client/email_template.rb

@@ -0,0 +1,5 @@
+module FubClient
+  class EmailTemplate < Resource
+    collection_path 'templates'
+  end
+end

data/lib/fub_client/event.rb

@@ -0,0 +1,8 @@
+module FubClient
+  class Event < Resource
+    attributes :created, :updated, :person_id, :message, :description,
+               :note_id, :source, :type, :property
+               
+    belongs_to :person
+  end
+end

data/lib/fub_client/middleware.rb

@@ -0,0 +1,7 @@
+require "fub_client/middleware/authentication"
+require "fub_client/middleware/parser"
+
+module FubClient
+  module Middleware
+  end
+end

data/lib/fub_client/middleware/authentication.rb

@@ -0,0 +1,11 @@
+module FubClient
+  module Middleware
+    class Authentication < Faraday::Middleware
+      def call(env)
+        env[:request_headers]["Authorization"] = "Basic " + 
+          Base64.strict_encode64("#{FubClient::Client.instance.api_key}:")
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/fub_client/middleware/parser.rb

@@ -0,0 +1,22 @@
+module FubClient
+  module Middleware
+    class Parser < Faraday::Response::Middleware
+      
+      def on_complete(env)
+        original_json = MultiJson.load(env[:body])
+        json = original_json.deep_transform_keys{ |k| k.to_s.snakecase.to_sym }
+        metadata = json[:_metadata]
+        if metadata.nil?
+          result = json
+        else
+          result = json[metadata[:collection].snakecase.to_sym]
+        end
+        env[:body] = {
+          data: result,
+          errors: json[:errors],
+          metadata: metadata
+        }
+      end
+    end
+  end
+end

data/lib/fub_client/note.rb

@@ -0,0 +1,4 @@
+module FubClient
+  class Note < Resource
+  end
+end

data/lib/fub_client/person.rb

@@ -0,0 +1,5 @@
+module FubClient
+  class Person < Resource
+    collection_path 'people'
+  end
+end

data/lib/fub_client/resource.rb

@@ -0,0 +1,14 @@
+module FubClient
+  class Resource
+    include Her::Model
+    use_api FubClient::Client.instance.her_api
+    
+    scope :by_page, -> (page, per_page) { 
+      where(offset: (page - 1)*per_page, limit: per_page) 
+    }
+    
+    def self.total
+      by_page(1, 1).metadata[:total]
+    end
+  end
+end

data/lib/fub_client/smart_list.rb

@@ -0,0 +1,5 @@
+module FubClient
+  class SmartList < Resource
+    collection_path 'smartLists'
+  end
+end

data/lib/fub_client/user.rb

@@ -0,0 +1,4 @@
+module FubClient
+  class User < Resource
+  end
+end

data/lib/fub_client/version.rb

@@ -0,0 +1,3 @@
+module FubClient
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: fub_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kyoto Kopz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: 
+email:
+- kopz9999@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fub_client.gemspec
+- lib/fub_client.rb
+- lib/fub_client/action_plan.rb
+- lib/fub_client/call.rb
+- lib/fub_client/client.rb
+- lib/fub_client/custom_field.rb
+- lib/fub_client/em_event.rb
+- lib/fub_client/email_template.rb
+- lib/fub_client/event.rb
+- lib/fub_client/middleware.rb
+- lib/fub_client/middleware/authentication.rb
+- lib/fub_client/middleware/parser.rb
+- lib/fub_client/note.rb
+- lib/fub_client/person.rb
+- lib/fub_client/resource.rb
+- lib/fub_client/smart_list.rb
+- lib/fub_client/user.rb
+- lib/fub_client/version.rb
+homepage: https://github.com/kopz9999/fub_client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for Follow Up Boss API http://www.followupboss.com
+test_files: []