onepagecrm 0.0.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2859dfc423493ac5aef46f2dc87faa6601d44ccb
-  data.tar.gz: d3f35388dec43c2472f12f99e9b91b418f872f38
+SHA256:
+  metadata.gz: 6f43b8af18d61a41037c8f68194d03d919f7474f0dc22ddbf532c0821d52faa0
+  data.tar.gz: aaf2df2075abd43f72d288fe2e5e7018b7d9b41bd5e65c2f68a1cde3989292fc
 SHA512:
-  metadata.gz: d9683174012ce7b0df6e3d76a81a445077910f244d762d14d8790904a6b8b92fe820acc274bf29f427e0256785d08b6e08e0120ece9057bf544ae824f2630699
-  data.tar.gz: 8d399642d5a675af251c91e6615345e4ceaa719264c57b848ce5392622ca76956000826d2ad353fd337448fe392dc8766b1a322347af975ddfd942cbf76870f2
+  metadata.gz: 0db66e59769acc854b5a97004ab8f350294487b598ac08b2e53764ec1530910944011702d9a07dede643ef934a1ca7273901583c07adaac3cf06b71ba4d7b351
+  data.tar.gz: 57ea63f3882375254073ed092d6ebc55c7eacf2634be5da8490072506282d8e49abcc7fe522128fa231c00474e3a225323caa7ca41c2e0d7b0ed5b3d81345b05

data/.gitignore

@@ -13,4 +13,5 @@
 *.a
 mkmf.log
 config.yml
+.idea/
 

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in onepagecrm.gemspec
 gemspec
+
+group :development, :test do
+  # Better ruby interpreter
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    onepagecrm (0.2.0)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    faraday (1.7.1)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.2.18)
+  onepagecrm!
+  pry
+  rake (~> 10.5)
+
+BUNDLED WITH
+   2.2.18

data/README.md

@@ -1,18 +1,14 @@
-[![Code Climate](https://codeclimate.com/github/peterOnePageCRM/onepagecrm-gem/badges/gpa.svg)](https://codeclimate.com/github/peterOnePageCRM/onepagecrm-gem)
+# OnePageCRM
 
-[![Test Coverage](https://codeclimate.com/github/peterOnePageCRM/onepagecrm-gem/badges/coverage.svg)](https://codeclimate.com/github/peterOnePageCRM/onepagecrm-gem)
-
-# Onepagecrm
-
-TODO: Write a gem description
+This gem is a basic wrapper around the OnePageCRM API. 
+It does not abstract all API calls to ruby methods on the gem object but simply gives the `GET`, `POST`, `PUT` and `DELETE` methods.
+The gem handles all the authentication with the OnePageCRM API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'onepagecrm'
-```
+    gem 'onepagecrm'
 
 And then execute:
 
@@ -23,13 +19,29 @@ Or install it yourself as:
     $ gem install onepagecrm
 
 ## Usage
+You can try out the OnePageCRM gem in an interactive ruby session
+    
+    $ irb
+    irb:> require 'onepagecrm'
+    irb:> api_client = OnePageCRM.new('user_id', 'api_key')
+    irb:> api_client.get('contacts.json')
+    irb:> api_client.post('contacts.json', {'last_name': 'Bravo', 'first_name': 'Johnny'} )
+
+Take a look at the [OnePageCRM Developer][1] site for more details on API functionality.
 
-TODO: Write usage instructions here
+## Support
+The best way to get support is through the [OnePageCRM Developer Forum][2]
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/onepagecrm/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+We welcome any contributions.
+
+1. Create an issue relating to the feature that you require.
+2. Fork the repo ( https://github.com/[my-github-username]/onepagecrm/fork )
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+  [1]: http://developer.onepagecrm.com
+  [2]: http://forum.developer.onepagecrm.com

data/lib/onepagecrm/version.rb

@@ -1,3 +1,4 @@
-class Onepagecrm
-  VERSION = '0.0.7'
+# Version for OnePageCRM gem
+class OnePageCRM
+  VERSION = '0.2.0'
 end

data/lib/onepagecrm.rb

@@ -1,123 +1,36 @@
 require 'onepagecrm/version'
-require 'net/http'
-require 'openssl'
 require 'base64'
 require 'json'
-require 'uri'
-
-class Onepagecrm
-  def initialize(login = nil, password = nil)
-    @url = 'https://app.onepagecrm.com/api/v3/'
-    @login = login
-    @password = password
-    log_in
-  end
-
-  # Login user into API
-  def log_in
-    params = {
-      login: @login,
-      password: @password
-    }
-
-    auth_data = post('login.json', params)
-    @uid = auth_data['data']['user_id']
-
-    @api_key = Base64.decode64(auth_data['data']['auth_key'])
-  end
-
-  def return_uid
-    @uid
-  end
-
-  # Send GET request
-  def get(method, params = {})
-    url = URI.parse(@url + method)
-    get_data = params.empty? ? '' : '?' + params.to_a.map do|x|
-      x[0] + '=' +
-      URI.escape(x[1], Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-    end.join('&').gsub(/%[0-9A-Fa-f]{2}/) { |x| x.downcase }
-
-    req = Net::HTTP::Get.new(url.request_uri)
-
-    add_auth_headers(req, 'GET', method, params)
-
-    http = Net::HTTP.new(url.host, url.port)
-    http.use_ssl = true
-    result = http.request(req).body
-    JSON.parse result
+require 'faraday'
+
+# OnePageCRM API Client Object
+class OnePageCRM
+  def initialize(user_id, api_key)
+    url = 'https://app.onepagecrm.com/api/v3/'
+    @conn = Faraday.new(url: url) do |conn|
+      conn.adapter Faraday.default_adapter
+      conn.basic_auth(user_id, api_key)
+      conn.headers.merge!(
+        'Content-Type' => 'application/json',
+        'X-OnePageCRM-UID' => user_id,
+        'X-OnePageCRM-Source' => 'ruby_gem'
+      )
     end
-
-  # Send POST request
-  def post(method, params = {})
-    url = URI.parse(@url + method)
-    req = Net::HTTP::Post.new(url.path)
-    req.body = params.to_json
-    req.add_field('Content-Type', 'application/json; charset=utf-8')
-
-    add_auth_headers(req, 'POST', method, params)
-
-    http = Net::HTTP.new(url.host, url.port)
-    http.use_ssl = true
-    result = http.request(req).body
-    JSON.parse result
   end
 
-  # Send PUT request
-  def put(method, params = {})
-    url = URI.parse(@url + method)
-    req = Net::HTTP::Put.new(url.path)
-    req.body = params.to_json
-    req.add_field('Content-Type', 'application/json; charset=utf-8')
-    add_auth_headers(req, 'PUT', method, params)
-
-    http = Net::HTTP.new(url.host, url.port)
-    http.use_ssl = true
-    result = http.request(req).body
-    JSON.parse result
+  # defines get and delete methods
+  %w(get delete).each do |http_method|
+    define_method http_method do |endpoint, params = {}|
+      response = @conn.send(http_method, endpoint, params)
+      JSON.parse response.body
+    end
   end
 
-  # Send DELETE request
-  def delete(method, params = {})
-    url = URI.parse(@url + method)
-
-    delete_data = params.empty? ? '' : '?' + params.to_a.map do|x|
-      x[0] + '=' +
-      URI.escape(x[1], Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-    end.join('&').gsub(/%[0-9A-Fa-f]{2}/) { |x| x.downcase }
-
-    req = Net::HTTP::Delete.new(url.request_uri)
-    add_auth_headers(req, 'DELETE', method, params)
-    http = Net::HTTP.new(url.host, url.port)
-    http.use_ssl = true
-    result = http.request(req).body
-    JSON.parse result
+  # Defines put and post methods
+  %w(post put).each do |http_method|
+    define_method http_method do |endpoint, params = {}|
+      response = @conn.send(http_method, endpoint, params.to_json)
+      JSON.parse response.body
     end
-
-  # Add authentication headers
-  def add_auth_headers(req, http_method, api_method, params)
-    return if @uid.nil? || @api_key.nil?
-
-    url_to_sign = @url + api_method
-    params_to_sign = params.empty? ? nil : URI.encode_www_form(params)
-    url_to_sign += '?' + params_to_sign unless params_to_sign.nil? || %w(POST PUT).include?(http_method)
-
-    # puts url_to_sign
-    timestamp = Time.now.to_i.to_s
-
-    token = create_signature(@uid, @api_key, timestamp, http_method, url_to_sign, params)
-
-    req.add_field('X-OnePageCRM-UID', @uid)
-    req.add_field('X-OnePageCRM-TS', timestamp)
-    req.add_field('X-OnePageCRM-Auth', token)
-    req.add_field('X-OnePageCRM-Source', 'lead_clip_chrome')
- end
-
-  def create_signature(uid, api_key, timestamp, request_type, request_url, request_body)
-    request_url_hash = Digest::SHA1.hexdigest request_url
-    request_body_hash = Digest::SHA1.hexdigest request_body.to_json
-    signature_message = [uid, timestamp, request_type.upcase, request_url_hash].join '.'
-    signature_message += ('.' + request_body_hash) unless request_body.empty?
-    OpenSSL::HMAC.hexdigest('sha256', api_key, signature_message).to_s
   end
 end

data/onepagecrm.gemspec

@@ -2,25 +2,22 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'onepagecrm/version'
-
 Gem::Specification.new do |spec|
   spec.name          = 'onepagecrm'
-  spec.version       = Onepagecrm::VERSION
+  spec.version       = OnePageCRM::VERSION
   spec.authors       = ['Peter Armstrong']
-  spec.email         = ['peter@onepagecrm.com']
-  spec.summary       = %q{Basic Gem for OnePageCRM.}
-  spec.description   = %q{Basic Gem for OnePageCRM.}
-  spec.homepage      = ''
+  spec.email         = ['devteam@onepagecrm.com']
+  spec.summary       = 'Basic Gem for OnePageCRM'
+  spec.description   = 'Basic Gem for the OnePageCRM API'
+  spec.homepage      = 'http://developer.onepagecrm.com'
   spec.license       = 'MIT'
-
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'json_spec'
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_dependency 'faraday'
+
+  spec.add_development_dependency 'bundler', '~> 2.2.18'
+  spec.add_development_dependency 'rake', '~> 10.5'
 end

metadata

@@ -1,51 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: onepagecrm
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Armstrong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !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
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,53 +25,50 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json_spec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.18
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Basic Gem for OnePageCRM.
+        version: '10.5'
+description: Basic Gem for the OnePageCRM API
 email:
-- peter@onepagecrm.com
+- devteam@onepagecrm.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- config/config_orig.yml
 - lib/onepagecrm.rb
 - lib/onepagecrm/version.rb
 - onepagecrm.gemspec
-- spec/contacts_spec.rb
-- spec/spec_helper.rb
-- tasks/rspec.rake
-homepage: ''
+homepage: http://developer.onepagecrm.com
 licenses:
 - MIT
 metadata: {}
@@ -118,11 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Basic Gem for OnePageCRM.
-test_files:
-- spec/contacts_spec.rb
-- spec/spec_helper.rb
+summary: Basic Gem for OnePageCRM
+test_files: []

data/config/config_orig.yml

@@ -1,2 +0,0 @@
-login: "login@example.com"
-password: "Password?Goes?Here?Ok?"

data/spec/contacts_spec.rb

@@ -1,53 +0,0 @@
-require 'spec_helper'
-require 'json_spec'
-
-describe Onepagecrm do
-  subject { Onepagecrm.new(TEST_CONFIG['login'], TEST_CONFIG['password']) }
-
-  describe '#create_contact' do
-    it 'creates a new contact' do
-      new_contact_details = ({
-        'first_name' => 'yes',
-        'last_name' => 'address',
-        'company_name' => 'ACME&inc',
-        'starred' => false,
-        'tags' => %w(api_test1 api_test2),
-        'emails' => [{
-          'type' => 'work',
-          'value' => 'johnny@exammmple.com' }],
-        'phones' => [{
-          'type' => 'work',
-          'value' => '00033353' }],
-        'urls' => [{
-          'type' => 'website',
-          'value' => 'lsdkiteboarding.com' }],
-        'background' => 'BACKGROUND',
-        'job_title' => 'JOBTITLE',
-        'address_list' => [
-          'city' => 'San Francisco',
-          'state' => 'CA'
-        ]
-      })
-
-      new_contact = subject.post('contacts.json', new_contact_details)['data']
-      new_contact_id = new_contact['contact']['id']
-      got_deets = subject.get("contacts/#{new_contact_id}.json")['data']['contact']
-      expect(got_deets['first_name']).to eq(new_contact_details['first_name'])
-
-      details_without_address = new_contact_details.reject { |k| k == 'address_list' }
-
-      details_without_address.each do |k, _v|
-        expect(got_deets[k]).to eq(new_contact_details[k])
-      end
-
-      # check address
-      address = got_deets['address_list'][0]
-      expect(address['city']).to eq 'San Francisco'
-      expect(address['state']).to eq 'CA'
-
-      # delete contact
-      subject.delete("contacts/#{new_contact_id}.json")
-    end
-  end
-
-end

data/spec/spec_helper.rb

@@ -1,7 +0,0 @@
-require 'yaml'
-require 'codeclimate-test-reporter'
-TEST_CONFIG = YAML.load_file("#{File.dirname(__FILE__)}/../config/config.yml")
-
-ENV['CODECLIMATE_REPO_TOKEN'] = TEST_CONFIG['codeclimate_key']
-CodeClimate::TestReporter.start
-require 'onepagecrm'

data/tasks/rspec.rake

@@ -1,3 +0,0 @@
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)