freshsales 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b588a2ecb49dd8ab5de0d2c2e43d3f45ca6048e9
-  data.tar.gz: 531664c1425cfc9b14ea3eaaafb0a7b0ed1ceba3
+  metadata.gz: 15cc945c608ab34a89ba51dc2297260e3059c448
+  data.tar.gz: 2a0c39b54b2da29038e3f290cf3021d8ad21b013
 SHA512:
-  metadata.gz: db59e03d374712a35b2fdf5d539c887864b326029c4930527d4cc03ea7e49dda72411084eb38615ffe2a58c1e6b191188bb0111c25c064735a5aea756b333313
-  data.tar.gz: db23ff551d53a5c1d74d19da05d97cb3ca4590881f79a5cb1019e68b6a27a8ab650dd8e7a6a3082ebd63a0116bdeb1d5bb4ca75b2f8d8fb628b4622a9d993162
+  metadata.gz: 37988f797ec440b64d5bd88fa8fa22bccc49d7fc590710ac72836ae62c9362a036c77ca3993d16ed6fd88ee903b9d743b087796d164ef9ea125bd645bcaa961f
+  data.tar.gz: e124629869c83af354ccaebef63684b3e7ec052c5cf4f8e595f7e456b47af4c13680712dba9d59d2ff339f6c4268e422eeda564d2d9260edab774838fa3aab96

data/.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-       - image: circleci/ruby:2.4.1-node-browsers
+       - image: cimg/ruby:2.5-browsers
       
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -51,4 +51,4 @@ jobs:
           path: /tmp/rspec/
       - store_artifacts:
           path: /tmp/rspec/
-          destination: test-results
+          destination: test-results

data/.github_changelog_generator

@@ -0,0 +1,2 @@
+future-release=v0.0.6
+exclude-labels=nochangelog,question

data/.rubocop.yml

@@ -5,9 +5,10 @@
 #
 #   File.chmod(0o777, f)
 #
-#AllCops:
+AllCops:
   #Include:
   #  - '**/fastlane/Fastfile'
+  TargetRubyVersion: 2.4
 
 # broken in 0.52.1
 Layout/EmptyLinesAroundArguments:
@@ -55,4 +56,4 @@ Layout/EndOfLine:
 
 # Some issues with rspec style
 Lint/AmbiguousBlockAssociation:
-  Enabled: false
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Change Log
+
+## [v0.0.4](https://github.com/DragonBox/freshsales/tree/v0.0.4) (2018-04-11)
+[Full Changelog](https://github.com/DragonBox/freshsales/compare/v0.0.3...v0.0.4)
+
+**Closed issues:**
+
+- Relax dependencies [\#5](https://github.com/DragonBox/freshsales/issues/5)
+
+## [v0.0.3](https://github.com/DragonBox/freshsales/tree/v0.0.3) (2018-04-10)
+[Full Changelog](https://github.com/DragonBox/freshsales/compare/v0.0.2...v0.0.3)
+
+## [v0.0.2](https://github.com/DragonBox/freshsales/tree/v0.0.2) (2018-04-10)
+[Full Changelog](https://github.com/DragonBox/freshsales/compare/v0.0.1...v0.0.2)
+
+**Implemented enhancements:**
+
+- add more configuration options [\#4](https://github.com/DragonBox/freshsales/issues/4)
+- handle errors \(Faraday::Error::ClientError\) [\#3](https://github.com/DragonBox/freshsales/issues/3)
+- Clean pagination API [\#2](https://github.com/DragonBox/freshsales/issues/2)
+
+## [v0.0.1](https://github.com/DragonBox/freshsales/tree/v0.0.1) (2018-04-07)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile.lock

@@ -1,80 +1,95 @@
 PATH
   remote: .
   specs:
-    freshsales (0.0.1)
-      faraday (~> 0.9.1)
-      multi_json (~> 1.11.0)
+    freshsales (0.0.6)
+      faraday (>= 0.16.0)
+      multi_json (>= 1.11.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.6)
+    activesupport (5.2.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    builder (3.2.3)
-    byebug (10.0.2)
-    coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    coveralls (0.8.21)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    colored (1.2)
+    concurrent-ruby (1.1.8)
+    coveralls (0.8.23)
       json (>= 1.8, < 3)
-      simplecov (~> 0.14.1)
+      simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
+      thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    faraday (0.9.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
-    github_changelog_generator (1.14.3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    github_changelog_generator (1.15.2)
       activesupport
       faraday-http-cache
       multi_json
       octokit (~> 4.6)
-      rainbow (>= 2.1)
+      rainbow (>= 2.2.1)
       rake (>= 10.0)
-      retriable (~> 2.1)
-    i18n (1.0.0)
+      retriable (~> 3.0)
+    hashdiff (1.0.1)
+    highline (1.7.10)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json (2.1.0)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    multi_json (1.11.3)
-    multipart-post (2.0.0)
-    octokit (4.8.0)
+    json (2.5.1)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    octokit (4.20.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.12.1)
-    parser (2.5.0.5)
-      ast (~> 2.4.0)
-    powerpack (0.1.1)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    public_suffix (3.0.2)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    powerpack (0.1.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (10.5.0)
-    retriable (2.1.0)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    rake (13.0.3)
+    retriable (3.1.2)
+    rexml (3.2.5)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
     rspec_junit_formatter (0.2.3)
       builder (< 4)
       rspec-core (>= 2, < 4, != 2.12.0)
@@ -85,37 +100,47 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    term-ansicolor (1.6.0)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.19.4)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    tins (1.16.3)
-    tzinfo (1.2.5)
+    tins (1.28.0)
+      sync
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.7.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.13)
+  bundler (~> 2.2)
+  colored (>= 1.2, < 2.0.0)
   coveralls
   freshsales!
   github_changelog_generator
+  highline (~> 1.7.10)
   pry-byebug
-  rake (~> 10.0)
-  rspec (~> 3.1.0)
+  rake (>= 12.3.3)
+  rspec (~> 3.8.0)
   rspec_junit_formatter (~> 0.2.3)
   rubocop (~> 0.52.1)
+  webmock (~> 3.3.0)
 
 BUNDLED WITH
-   1.16.1
+   2.2.16

data/README.md

@@ -1,11 +1,11 @@
-# U3D
+# Freshsales
 
 [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/DragonBox/freshsales/blob/master/LICENSE)
-[![Gem](https://img.shields.io/gem/v/u3d.svg?style=flat)](https://rubygems.org/gems/freshsales)
+[![Gem](https://img.shields.io/gem/v/freshsales.svg?style=flat)](https://rubygems.org/gems/freshsales)
 [![Build Status](https://img.shields.io/circleci/project/DragonBox/freshsales/master.svg?style=flat)](https://circleci.com/gh/DragonBox/freshsales)
 [![Coverage Status](https://coveralls.io/repos/github/DragonBox/freshsales/badge.svg?branch=master)](https://coveralls.io/github/DragonBox/freshsales?branch=master)
 
-Freshsales is a ruby wrapper around Freshsales API.
+Freshsales is a ruby wrapper around [Freshsales API](https://www.freshsales.io/api/)
 
 ---
 
@@ -15,46 +15,103 @@ Freshsales is a ruby wrapper around Freshsales API.
 gem install freshsales
 ```
 
+### Requirements
+
+A Freshsales account and an API key. You can set your API key here.
+
+https://yourdomain.freshsales.io/personal-settings/api-settings
+
 ## Getting started
 
 ```ruby
-config = {}
-config[:freshsales_token] = "...."
-config[:freshsales_domain] = "yourdomain" # from https://yourdomain.freshsales.io/
-Freshsales::API.new(config)
+# given https://yourdomain.freshsales.io/ and your API key
+freshsales = Freshsales::API.new(freshsales_domain: "yourdomain", freshsales_apikey: "...")
 ```
 
+### Design philosophy
+
+Freshsales expose resources using a RESTful API allowing to [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) those resources. It also provides extra features such as search.
+
+Inspired by [gibbon](https://github.com/amro/gibbon), this library provides a simple dynamic language to construct the URLs required to query those resources.
+
+E.g. `freshsales.leads.post(body: requestbody)` would represent a `POST /api/leads/` request and return a `Freshsale::Response` instance.
+
+The json data (`requestbody`) can be passed as string or Hashes.
+
+The received json data can be obtained as raw or Hashes (with symbolized keys or not).
+
 ## Examples
 
-* Create / Update / Get / Delete
+### Create / Read / Update / Search / Delete resources
 
 ```ruby
 email = "sample@sample.com"
 
 lead_data = %({"lead":{"last_name":"Sampleton (sample)", "email": "#{email}"}})
 
-# create lead
+# Create lead
 result = freshsales.leads.post(body: lead_data)
 lead_id = result.body['lead']['id']
 
 updated_lead_data = %({"lead":{"mobile_number":"1-926-555-9999", "email": "#{email}"}})
 
-# update the lead
-freshsales.leads(lead_id).put(body: updated_lead_data).body
-
-# get the lead
+# Read the lead
 freshsales.leads(lead_id).get.body
 
-# search the lead by email
+# Update the lead
+freshsales.leads(lead_id).put(body: updated_lead_data).body
+
+# Search the lead by email
 sample = freshsales.search.get(params: {include: "lead", q: email}).body.first
 
-# delete it
+# Delete it
 freshsales.leads(lead_id).delete
 ```
 
+### Finding a particular view
+
+```ruby
+filters = freshsales.contacts.filters.get
+
+view_id = filters.body['filters'].select{|f| "All Contacts" == f['name'] }.first['id']
+```
+
+### Paginated resources
+
+Some resources are paginated and controlled by the `per_page` and `page` parameters.
+
+While you can return individual pages like this:
+```ruby
+freshsales.contacts.view(view_id).get(params: {"per_page": 100, "page": 2}).body
+```
+
+the library also allows to iterate over all pages either one element at a time or one page at a time, lazily making the requests for the different pages when required by the client.
+
+```ruby
+freshsales.contacts.view(view_id).get_all.each do |contact|
+  # do something with this contact, which may come from any page
+end
+
+page_params = { "per_page": 100, "sort": "id", "sort_type": "asc", "include": "owner,creater,source"}
+freshsales.contacts.view(view_id).get_all_pages(params: page_params).each do |contact_page|
+  # do something with this page's data which may contain up to 100 contacts and
+  # their associated owner, creater and source data
+end
+```
+
+`get_all` and `get_all_pages` return a `Freshsale::Cursor` whose `each` method returns a ruby `Enumerator` when no block is given.
+
+**tip** Enumerators in ruby can be used as [Enumerable](https://ruby-doc.org/core/Enumerable.html). This allows you to apply collection operations on them, even chain them, to transform or filter the returned data.
+
+E.g. if you wanted to restrict the number of elements/pages you could do `get_all[_pages].each.take(100)[.each]`.
+
 ### Troubleshoot
 
-Enable the `debug` option
+Enable the `debug` option (`Freshsales::API.new(debug: true)`)
+
+### WIP / first public release
+
+The library is a work in progress. There will be a couple of API changes before the first public version is officially rolled out. Check [the issues targeted for the 0.1.0 milestone](https://github.com/DragonBox/freshsales/issues?q=is%3Aopen+is%3Aissue+milestone%3A0.1.0)
 
 ### Solve SSL Errors
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2018-present WeWantToKnow AS
 #
@@ -24,9 +26,239 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require 'rubocop/rake_task'
 
+require 'logger'
+require 'colored'
+require 'highline/import'
+module UI
+  # raised from crash!
+  class UICrash < StandardError
+  end
+
+  class EPipeIgnorerLogDevice < Logger::LogDevice
+    def initialize(logdev)
+      @logdev = logdev
+    end
+
+    # rubocop:disable HandleExceptions
+    def write(message)
+      @logdev.write(message)
+    rescue Errno::EPIPE
+      # ignored
+    end
+    # rubocop:enable HandleExceptions
+  end
+  class << self
+    def log
+      return @log if @log
+
+      $stdout.sync = true
+
+      @log ||= Logger.new(EPipeIgnorerLogDevice.new($stdout))
+
+      @log.formatter = proc do |severity, datetime, _progname, msg|
+        "#{format_string(datetime, severity)}#{msg}\n"
+      end
+
+      @log
+    end
+
+    def verbose?
+      false
+    end
+
+    def format_string(datetime = Time.now, severity = "")
+      timestamp ||= if verbose?
+                      '%Y-%m-%d %H:%M:%S.%2N'
+                    else
+                      '%H:%M:%S'
+                    end
+      s = []
+      s << "#{severity} " if verbose? && severity && !severity.empty?
+      s << "[#{datetime.strftime(timestamp)}] " if timestamp
+      s.join('')
+    end
+
+    def confirm(message)
+      verify_interactive!(message)
+      agree("#{format_string}#{message.to_s.yellow} (y/n)", true)
+    end
+
+    def user_error!(message)
+      raise StandardError, message.to_s.red
+    end
+
+    def input(message)
+      verify_interactive!(message)
+      ask("#{format_string}#{message.to_s.yellow}").to_s.strip
+    end
+
+    def error(message)
+      log.error(message.to_s.red)
+    end
+
+    def important(message)
+      log.error(message.to_s.yellow)
+    end
+
+    def success(message)
+      log.error(message.to_s.green)
+    end
+
+    def message(message)
+      log.info(message.to_s)
+    end
+
+    def deprecated(message)
+      log.error(message.to_s.bold.blue)
+    end
+
+    def command(message)
+      log.info("$ #{message}".cyan.underline)
+    end
+
+    def interactive?
+      interactive = true
+      interactive = false if $stdout.isatty == false
+      # interactive = false if Helper.ci?
+      return interactive
+    end
+
+    private
+
+    def verify_interactive!(message)
+      return if interactive?
+      important(message)
+      crash!("Could not retrieve response as the program runs in non-interactive mode")
+    end
+
+    def crash!(exception)
+      raise UICrash.new, exception.to_s
+    end
+  end
+end
+
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
+class GithubChangelogGenerator
+  PATH = '.github_changelog_generator'
+  class << self
+    def future_release
+      s = File.read(PATH)
+      s.split("\n").each do |line|
+        m = line.match(/future-release=v(.*)/)
+        return m[1] if m
+      end
+      raise "Couldn't find future-release in #{PATH}"
+    end
+
+    def future_release=(nextv)
+      s = File.read(PATH)
+      lines = s.split("\n").map do |line|
+        m = line.match(/future-release=v(.*)/)
+        if m
+          "future-release=v#{nextv}"
+        else
+          line
+        end
+      end
+      File.write(PATH, lines.join("\n") + "\n")
+    end
+  end
+end
+
+class FreshsalesCode
+  PATH = 'lib/freshsales/version.rb'
+  class << self
+    def version=(version)
+      s = File.read(PATH)
+      lines = s.split("\n").map do |line|
+        m = line.match(/(.*VERSION = ['"]).*(['"].*)/)
+        if m
+          "#{m[1]}#{version}#{m[2]}"
+        else
+          line
+        end
+      end
+      File.write(PATH, lines.join("\n") + "\n")
+    end
+  end
+end
+
+require 'English'
+def run_command(command, error_message = nil)
+  output = `#{command}`
+  unless $CHILD_STATUS.success?
+    error_message = "Failed to run command '#{command}'" if error_message.nil?
+    UI.user_error!(error_message)
+  end
+  output
+end
+
+task :ensure_git_clean do
+  branch = run_command('git rev-parse --abbrev-ref HEAD', "Couldn't get current git branch").strip
+  UI.user_error!("You are not on 'master' but on '#{branch}'") unless branch == "master"
+  output = run_command('git status --porcelain', "Couldn't get git status")
+  UI.user_error!("git status not clean:\n#{output}") unless output == ""
+end
+
+# ensure ready to prepare a PR
+task :prepare_git_pr, [:pr_branch] do |_t, args|
+  pr_branch = args['pr_branch']
+  raise "Missing pr_branch argument" unless pr_branch
+  UI.user_error! "Prepare git PR stopped by user" unless UI.confirm("Creating PR branch #{pr_branch}")
+  run_command("git checkout -b #{pr_branch}")
+end
+
+desc 'Prepare a release: check repo status, generate changelog, create PR'
+task pre_release: 'ensure_git_clean' do
+  require 'freshsales/version'
+  nextversion = Freshsales::VERSION
+
+  # check not already released
+  output = run_command("git tag -l v#{nextversion}").strip
+  UI.user_error! "Version '#{nextversion}' already released. Run 'rake bump'" unless output == ''
+
+  gh_future_release = GithubChangelogGenerator.future_release
+  UI.user_error! "GithubChangelogGenerator version #{gh_future_release} != #{nextversion}" unless gh_future_release == nextversion
+
+  pr_branch = "release_#{nextversion}"
+  Rake::Task["prepare_git_pr"].invoke(pr_branch)
+
+  Rake::Task["changelog"].invoke
+
+  sh('git diff')
+  # FIXME: cleanup branch, etc
+  UI.user_error! "Pre release stopped by user." unless UI.confirm("CHANGELOG PR for version #{nextversion}. Confirm?")
+
+  msg = "Preparing release for #{nextversion}"
+  sh 'git add CHANGELOG.md'
+  sh "git commit -m '#{msg}'"
+  sh "git push lacostej" # FIXME: hardcoded
+  # FIXME: check hub present
+  sh "hub pull-request -m '#{msg}'" # requires hub pre-release " -l nochangelog"
+  sh 'git checkout master'
+  sh "git branch -D #{pr_branch}"
+end
+
+desc 'Bump the version number to the version entered interactively; pushes a commit to master'
+task bump: 'ensure_git_clean' do
+  nextversion = UI.input "Next version will be:"
+  UI.user_error! "Bump version stopped by user" unless UI.confirm("Next version will be #{nextversion}. Confirm?")
+  FreshsalesCode.version = nextversion
+  GithubChangelogGenerator.future_release = nextversion
+  sh 'rspec'
+  sh 'git add .github_changelog_generator lib/freshsales/version.rb Gemfile.lock'
+  sh "git commit -m 'Bump version to #{nextversion}'"
+  sh 'git push'
+end
+
+desc 'Update the changelog, no commit made'
+task :changelog do
+  puts "Updating changelog #{ENV['CHANGELOG_GITHUB_TOKEN']}"
+  sh "github_changelog_generator" if ENV['CHANGELOG_GITHUB_TOKEN']
+end
+
 desc 'Run all rspec tests'
 task :test_all do
   formatter = "--format progress"

data/appveyor.yml

@@ -9,6 +9,7 @@ init:
 
 install:
   - set PATH=C:\Ruby24-x64\bin;%PATH%
+  - gem install bundler
   - bundle install
 
 environment:

data/freshsales.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'freshsales/version'
@@ -8,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors     = ["Jerome Lacoste"]
   spec.email       = 'jerome@wewanttoknow.com'
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.4.0'
 
   spec.summary     = "Freshsales"
   spec.description = 'A wrapper for Freshsales API'
@@ -22,16 +24,19 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # using same minimal dependencies as gibbon, for the sake of compatibility
-  spec.add_dependency 'faraday', '~> 0.9.1'
-  spec.add_dependency 'multi_json', '~> 1.11.0'
+  spec.add_dependency 'faraday', '>= 0.16.0'
+  spec.add_dependency 'multi_json', '>= 1.11.0'
 
   # Development only
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "colored", '>= 1.2', '< 2.0.0'
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "github_changelog_generator"
+  spec.add_development_dependency "highline", "~> 1.7.10"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.8.0"
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2.3'
   spec.add_development_dependency 'rubocop', '~> 0.52.1'
+  spec.add_development_dependency "webmock", "~> 3.3.0"
 end

data/lib/freshsales.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2018-present WeWantToKnow AS
 #
@@ -24,7 +26,6 @@ require 'logger'
 require 'uri'
 require 'cgi'
 require 'multi_json'
-require 'pry'
 require 'faraday'
 
 require 'freshsales/version'

data/lib/freshsales/api.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 module Freshsales
   class API
-    attr_accessor :freshsales_token, :freshsales_domain, :debug, :symbolize_keys, :logger, :adapter, :proxy
+    attr_accessor :freshsales_apikey, :freshsales_domain, :debug, :symbolize_keys, :logger, :faraday_adapter, :proxy, :raw_data
 
     def initialize(opts = {})
-      @freshsales_token = opts.fetch(:freshsales_token, ENV["FRESHSALES_TOKEN"])
+      @freshsales_apikey = opts.fetch(:freshsales_apikey, ENV["FRESHSALES_APIKEY"])
       @freshsales_domain = opts.fetch(:freshsales_domain, ENV["FRESHSALES_DOMAIN"])
-      @symbolize_keys = false
+      @raw_data = opts.fetch(:raw_data, false)
+      @symbolize_keys = opts.fetch(:symbolize_keys, false)
       @debug = opts.fetch(:debug, false)
-      @logger = ::Logger.new(STDOUT)
-      @adapter = Faraday.default_adapter
-      @proxy = nil
+      @logger = opts.fetch(:logger, ::Logger.new(STDOUT))
+      @faraday_adapter = opts.fetch(:faraday_adapter, Faraday.default_adapter)
+      @proxy = opts.fetch(:proxy, ENV["FRESHSALES_PROXY"])
 
       @client = Client.new(self)
     end

data/lib/freshsales/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Freshsales
   class Client
     def initialize(config)
@@ -18,20 +20,24 @@ module Freshsales
       parsed_response = nil
 
       if response.body && !response.body.empty?
-        begin
-          headers = response.headers
-          body = MultiJson.load(response.body, symbolize_keys: @config.symbolize_keys)
-          parsed_response = Response.new(headers: headers, body: body)
-        rescue MultiJson::ParseError
-          error_params = { title: "UNPARSEABLE_RESPONSE", status_code: 500 }
-          error = FreshsalesError.new("Unparseable response: '#{response.body}'", error_params)
-          raise error
-        end
+        headers = response.headers
+        body = response.body
+        body = jsonify_body(body) unless @config.raw_data
+        parsed_response = Response.new(headers: headers, body: body)
       end
 
       parsed_response
     end
 
+    def jsonify_body(body, ignore_parsing_errors: false)
+      MultiJson.load(body, symbolize_keys: @config.symbolize_keys)
+    rescue MultiJson::ParseError => e
+      return if ignore_parsing_errors
+      error_params = { detail: e.message, status_code: 500, raw_body: body }
+      error = FreshsalesError.new("Unparseable response", error_params)
+      raise error
+    end
+
     def freshsales_domain
       "https://#{@config.freshsales_domain}.freshsales.io"
     end
@@ -47,6 +53,32 @@ module Freshsales
         end
         request.url path
       end
+    rescue StandardError => e
+      handle_request_error(e)
+    end
+
+    def handle_request_error(error)
+      error_params = {}
+      if error.is_a?(Faraday::ClientError) && error.response
+        error_params[:status_code] = error.response[:status]
+        error_params[:raw_body] = error.response[:body]
+
+        parsed_response = jsonify_body(error.response[:body], ignore_parsing_errors: true)
+
+        if parsed_response
+          error_params[:body] = parsed_response
+
+          code_key = @config.symbolize_keys ? :code : "code"
+          message_key = @config.symbolize_keys ? :message : "message"
+
+          error_params[:code] = parsed_response[code_key] if parsed_response[code_key]
+          error_params[:detail] = parsed_response[message_key] if parsed_response[message_key]
+        end
+      end
+      message = error_params[:detail] || error.message
+      error_to_raise = FreshsalesError.new(message, error_params)
+
+      raise error_to_raise
     end
 
     def connection
@@ -55,13 +87,13 @@ module Freshsales
           Faraday.new(freshsales_domain, proxy: @config.proxy, ssl: { version: "TLSv1_2" }) do |c|
             # c.request  :url_encoded
             c.response :raise_error
-            c.use Faraday::Request::Authorization, 'Token', "token=#{@config.freshsales_token}"
+            c.use Faraday::Request::Authorization, 'Token', "token=#{@config.freshsales_apikey}"
             if @config.debug
               c.response :logger, @config.logger, bodies: true do |logger|
                 logger.filter(/(Token token=)(\w+)/, '\1[HIDDEN]')
               end
             end
-            c.adapter @config.adapter
+            c.adapter @config.faraday_adapter
           end
         end
     end

data/lib/freshsales/cursor.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Freshsales
   class Cursor
     include Enumerable
 
-    def initialize(client, path, type, collection_name, args)
+    def initialize(client, path, type, collection_name, args = {})
       @client = client
       @path       = path
       @type       = type
@@ -41,8 +43,6 @@ module Freshsales
       @client.logger
     end
 
-    MAX = 100_000 # FIXME: get rid off or configure
-
     def fetch_next_page
       nextpage = @page + 1
       @args[:params] = params.merge(page: nextpage)
@@ -68,8 +68,10 @@ module Freshsales
         logger.debug "Found #{j.count} elements #{@type} #{@collection_name}"
 
         data = j
+      elsif j.is_a? String
+        raise "Unexpected data type received #{j.class}. Are you combining pagination with raw_data? Unsupported for now"
       else
-        raise "Unexpected data type received #{j.class}"
+        raise "Unexpected data type received #{j.class}."
       end
 
       @last_response = last
@@ -78,7 +80,7 @@ module Freshsales
     end
 
     def last?
-      @last_response || @collection.size >= MAX
+      @last_response
     end
   end
 end

data/lib/freshsales/freshsales_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Freshsales
   class FreshsalesError < StandardError
     attr_reader :params

data/lib/freshsales/request_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Freshsales
   class RequestBuilder
     def initialize(client)

data/lib/freshsales/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Freshsales
   class Response
     attr_accessor :headers, :body

data/lib/freshsales/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Freshsales
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.6"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: freshsales
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Jerome Lacoste
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-07 00:00:00.000000000 Z
+date: 2021-04-18 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.1
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.11.0
 - !ruby/object:Gem::Dependency
@@ -44,14 +44,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.10
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -98,30 +132,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +184,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 description: A wrapper for Freshsales API
 email: jerome@wewanttoknow.com
 executables: []
@@ -159,16 +207,17 @@ files:
 - ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github_changelog_generator"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- TODO
 - appveyor.yml
 - freshsales.gemspec
 - lib/freshsales.rb
@@ -183,7 +232,7 @@ homepage: https://github.com/DragonBox/freshsales
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,16 +240,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14
+signing_key:
 specification_version: 4
 summary: Freshsales
 test_files: []

data/TODO

@@ -1,6 +0,0 @@
-* code cleanup
-# clean pagination API
-# handle errors (Faraday::Error::ClientError)
-# configuration options
-
-* rspecs