onepagecrm 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af6d0d2b43457fbf7e400f2aecd5b417e77ea3c6
-  data.tar.gz: d507d507240c193a41c48ea00c56a253af1ae191
+  metadata.gz: 4adc5612ded228721cf379dbf3c151d1cb69e13c
+  data.tar.gz: a4e7ccae4fa0db6e08035437a8d33713d87f04ac
 SHA512:
-  metadata.gz: 64a3ce994c2dbafe5112c8780b7bd020db87ca58618073a6ba3f3376b839c1c4d147730e62c9e6f122ef11ddf7b313bd24053a9b449d9dd57fa834eeed1b39fa
-  data.tar.gz: 49268667cf1e52a763311a41f729f8df9334b9b5d101e55e683bd4dd4a86a53b608d92c326ff656031a996eecc7cf63322fe501d0763e77b141fb6830bc43415
+  metadata.gz: 12c77b6739e38e78ae6ec82e6a18c4a6921580049be07d05f590746bf36f5f16f7eeea3853dafcdb2e5a7d190c4bb4f508dcf4fd271b6a610c5f6e43195b1687
+  data.tar.gz: ddee2ab11c51a33e4ac4afacf49671a9857bd71aaeb9357d63f935c3864246d74fb1adc0fd1a0c9d15451a7e43b3b23914af0683842b64037c15471a450c66a8

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('peter@xap.ie', 'p3t3r3t3p')
+    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.rb

@@ -4,7 +4,7 @@ require 'json'
 require 'faraday'
 
 # OnePageCRM API Client Object
-class Onepagecrm
+class OnePageCRM
   def initialize(login = nil, password = nil)
     @url = 'https://app.onepagecrm.com/api/v3/'
     @conn = Faraday.new(url: @url)
@@ -50,7 +50,8 @@ class Onepagecrm
     token = create_auth_token(http_method, url, parameters, timestamp)
     { 'X-OnePageCRM-UID' => @uid,
       'X-OnePageCRM-TS' => timestamp,
-      'X-OnePageCRM-Auth' => token
+      'X-OnePageCRM-Auth' => token,
+      'X-OnePageCRM-Source' => 'ruby_gem'
      }.merge op_headers
   end
 

data/lib/onepagecrm/version.rb

@@ -1,4 +1,4 @@
-# Version for Oneapgecrm gem
-class Onepagecrm
-  VERSION = '0.0.9'
+# Version for OnePageCRM gem
+class OnePageCRM
+  VERSION = '0.1.0'
 end

data/onepagecrm.gemspec

@@ -2,17 +2,15 @@
 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.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)/})
@@ -22,12 +20,4 @@ Gem::Specification.new do |spec|
 
   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_development_dependency 'pry'
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'vcr'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onepagecrm
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Armstrong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,128 +52,15 @@ dependencies:
     - - "~>"
       - !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: json_spec
-  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: codeclimate-test-reporter
-  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
-  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: guard
-  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: guard-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: awesome_print
-  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'
-description: Basic Gem for OnePageCRM.
+description: Basic Gem for the OnePageCRM API
 email:
-- peter@onepagecrm.com
+- devteam@onepagecrm.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -181,9 +68,6 @@ files:
 - lib/onepagecrm.rb
 - lib/onepagecrm/version.rb
 - onepagecrm.gemspec
-- spec/contacts_spec.rb
-- spec/spec_helper.rb
-- tasks/rspec.rake
 homepage: http://developer.onepagecrm.com
 licenses:
 - MIT
@@ -204,10 +88,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 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: []
+has_rdoc: 

data/Guardfile

@@ -1,9 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :rspec, cmd: 'bundle exec rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { 'spec' }
-end
-

data/spec/contacts_spec.rb

@@ -1,62 +0,0 @@
-require 'spec_helper'
-require 'json_spec'
-require 'pry'
-require 'awesome_print'
-
-describe Onepagecrm do
-  subject { Onepagecrm.new(TEST_CONFIG['login'], TEST_CONFIG['password']) }
-
-  describe '#contact' do
-    it 'creates, gets, updates and deletes a contact' do
-
-      contacts = subject.get('contacts.json')
-      expect(contacts['status']).to eq 0
-      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?search=yes")['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'
-
-      subject.put("contacts/#{new_contact_id}.json", { 'partial' => true,
-                                                       'first_name' => 'Pat' })
-      got_deets = subject.get("contacts/#{new_contact_id}.json")['data']['contact']
-      expect(got_deets['first_name']).to eq 'Pat'
-
-      # 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,5 +0,0 @@
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new do |task|
-  task.rspec_opts = ['--color', '--format', 'doc']
-end