bims_api_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5896e79cb5bdcbaacb56836a099e849a8409a0c
+  data.tar.gz: 2d2dace925eec649c693de849da0cb031375b020
+SHA512:
+  metadata.gz: c4e8f55d2b9bb074501accf8ce87fafa11e2020b7a0f11916381bc614514f2ebd248a1a294ebd75a5cb58428270f58c1e329506e6c2ca80d43d8f7a769e22b4a
+  data.tar.gz: bd562f839951be2efe5a981d958a95de9e38252cbde0c2a47d369273e35cb9295dd1ffc8cb3fea83807cdff288a2e3fb19f49e49fe410b962560bf9fc0a63649

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+.idea/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.0.pre.1

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 cmelgarejo@centralgps.net. 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) 2016 Christian Melgarejo
+
+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,71 @@
+# BIMS API Client
+
+Allows your project to connect to the BIMS platform and perform integration operations using your account.
+ 
+Please visit http://www.getbims.com/ for more information
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bims_api_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bims_api_client
+
+## Requirements
+
+* Ruby 2.x.x
+* Redis
+
+## Usage
+
+Just `include` it :)
+
+```
+include BimsApiClient
+```
+
+And initialize the configuration
+
+```
+  BimsApiClient.configure do |cfg|
+    cfg.redis_url = ENV['BAC_REDIS_URL'] #Your Redis instance URL
+    cfg.username = ENV['BAC_USERNAME'] #Your BIMS username
+    cfg.password = ENV['BAC_PASSWORD']#Your BIMS password
+    cfg.instance_name = ENV['BAC_INSTANCE_NAME'] #Your BIMS Instance name
+    cfg.instance_url = ENV['BAC_INSTANCE_URL'] #Your BIMS Instance URL (Include the /api)
+  end
+  #And initialize the client
+  BimsApiClient.init
+```
+
+Then use the methods: 
+```
+BimsApiClient.login
+BimsApiClient.logout
+(more to come...)
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cmelgarejo/bims_api_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/bims_api_client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bims_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'bims_api_client'
+  spec.version = BimsApiClient::VERSION
+  spec.authors = ['Christian Melgarejo']
+  spec.email = ['cmelgarejo@centralgps.net']
+
+  spec.summary = 'Allows your project to connect to the BIMS platform and perform integration operations using your account.'
+  spec.description = 'Allows your project to connect to the BIMS platform and perform integration operations using your account.'
+  spec.homepage = 'https://github.com/cmelgarejo/bims_api_client'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13.a'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'dotenv'
+  spec.add_runtime_dependency 'httparty', '~> 0.13.7'
+  spec.add_runtime_dependency 'redis', '~> 3.2'
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bims_api_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,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+

data/lib/bims_api_client.rb

@@ -0,0 +1,128 @@
+require 'bims_api_client/version'
+require 'redis'
+require 'httparty'
+require 'configuration'
+
+module BimsApiClient
+  include HTTParty
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  default_timeout 320 # hard timeout after 1 second
+
+  def init
+    success = false
+    begin
+      success = setup_redis(@configuration.redis_url) && set_api_base_uri(@configuration.instance_url)
+    rescue => e #debug the error
+      puts e.to_s
+    end
+    return success
+  end
+
+  def not_initialized?
+    !@configuration.instance_url && !@configuration.instance_name
+  end
+
+  def setup_redis(redis_url)
+    @redis = Redis.new(url: redis_url)
+  end
+
+  def set_api_base_uri(uri)
+    success = false
+    begin
+      base_uri uri
+      success = true
+    rescue => e
+      puts e.to_s #debug the error
+    end
+    return success
+  end
+
+  def set_error_object(data = nil)
+    {status: 'error', code: -1, data: data}
+  end
+
+  def session_active?
+    (@redis.get('bims_sid') && !@redis.get('bims_sid').empty?) ? true : false
+  end
+
+  def login(username = (@configuration.username), password = (@configuration.password))
+    success = false
+    begin
+      return false if not_initialized?
+      response_object = _login(username, password)
+      if response_object[@configuration.status_key] == @configuration.status_value_ok
+        @redis.set('bims_sid', response_object[@configuration.data_key][@configuration.data_session_key][@configuration.data_session_id_key].to_s)
+        success = true
+      end
+    rescue => e
+      puts e.to_s #debug the error
+    end
+    return success
+  end
+
+  def logout
+    begin
+      return false if not_initialized?
+      sid = @redis.get('bims_sid')
+      @redis.set('bims_sid', nil)
+      response_object = _logout(sid)
+      response_object[@configuration.status_key] == @configuration.status_value_ok ? true : false
+    rescue => e
+      puts e.to_s #debug the error
+    end
+  end
+
+  private
+  #Call to the BIMS API "login" method and gets the whole response body
+  def _login(username, password)
+    begin
+      return set_error_object({message: @configuration.not_initialized_message}) if not_initialized?
+      url = "#{base_uri}/#{@configuration.users_path}/login.#{@configuration.api_request_format}"
+      response = post url, body: {user: username, password: Digest::MD5.hexdigest(password)}
+      JSON.parse (response.body && !response.body.empty?) ? response.body : set_error_object #returns the complete object
+    rescue => e
+      puts e.to_s #debug the error
+    end
+  end
+
+  #Call to the BIMS API "logout" method and gets the whole response body
+  def _logout(sid)
+    begin
+      return set_error_object({message: @configuration.not_initialized_message}) if not_initialized?
+      url = "#{base_uri}/#{@configuration.users_path}/logout.#{@configuration.api_request_format}"
+      response = post url, body: {sid: sid}
+      JSON.parse (response.body && !response.body.empty?) ? response.body : set_error_object #returns the complete object
+    rescue => e
+      puts e.to_s #debug the error
+    end
+  end
+
+  #Call to the BIMS API "sales_add" method and gets the whole response body
+  def _sales_add(sale_data)
+    begin
+      return set_error_object({message: @configuration.not_initialized_message}) if not_initialized?
+      url = "#{base_uri}/#{@configuration.sales_path}/add.#{@configuration.api_request_format}"
+      response = post url, body: {data: sale_data}
+      JSON.parse (response.body && !response.body.empty?) ? response.body : set_error_object #returns the complete object
+    rescue => e
+      puts e.to_s #debug the error
+    end
+  end
+
+end

data/lib/bims_api_client/version.rb

@@ -0,0 +1,3 @@
+module BimsApiClient
+  VERSION = '0.0.1'
+end

data/lib/configuration.rb

@@ -0,0 +1,27 @@
+module BimsApiClient
+  class Configuration
+    attr_accessor :not_initialized_message, :api_request_format, :users_path, :contacts_path, :sales_path, :status_key,
+                  :status_value_ok, :status_value_error, :code_key, :data_key, :data_session_key, :data_session_id_key,
+                  :redis_url, :username, :password, :instance_name, :instance_url
+
+    def initialize
+      @not_initialized_message = 'Client not initialized'
+      @api_request_format = 'json'
+      @users_path = 'users'
+      @contacts_path = 'contacts'
+      @sales_path = 'sales'
+      @status_key = 'status'
+      @status_value_ok = 'ok'
+      @status_value_error = 'error'
+      @code_key = 'code'
+      @data_key = 'data'
+      @data_session_key = 'Session'
+      @data_session_id_key = 'id'
+      @redis_url = 'redis://127.0.0.1:6379'
+      @username = nil
+      @password = nil
+      @instance_name = nil
+      @instance_url = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: bims_api_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Melgarejo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.a
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Allows your project to connect to the BIMS platform and perform integration
+  operations using your account.
+email:
+- cmelgarejo@centralgps.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bims_api_client.gemspec
+- bin/console
+- bin/setup
+- lib/bims_api_client.rb
+- lib/bims_api_client/version.rb
+- lib/configuration.rb
+homepage: https://github.com/cmelgarejo/bims_api_client
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Allows your project to connect to the BIMS platform and perform integration
+  operations using your account.
+test_files: []