freshsales 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b588a2ecb49dd8ab5de0d2c2e43d3f45ca6048e9
+  data.tar.gz: 531664c1425cfc9b14ea3eaaafb0a7b0ed1ceba3
+SHA512:
+  metadata.gz: db59e03d374712a35b2fdf5d539c887864b326029c4930527d4cc03ea7e49dda72411084eb38615ffe2a58c1e6b191188bb0111c25c064735a5aea756b333313
+  data.tar.gz: db23ff551d53a5c1d74d19da05d97cb3ca4590881f79a5cb1019e68b6a27a8ab650dd8e7a6a3082ebd63a0116bdeb1d5bb4ca75b2f8d8fb628b4622a9d993162

data/.circleci/config.yml

@@ -0,0 +1,54 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+      
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path .bundle
+
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+        
+      # Database setup
+      # - run: bundle exec rake db:create
+      # - run: bundle exec rake db:schema:load
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            bundle exec rake
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/rspec/
+      - store_artifacts:
+          path: /tmp/rspec/
+          destination: test-results

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!--
+Thank you for helping freshsales to get better!
+Before you post your issue, please make sure that you checked the boxes! (put an x in the [ ] without spaces)
+If possible, try to indicate what type of issue you are facing with the tags!
+-->
+
+### Issue Checklist
+
+- [ ] I'm using the latest freshsales version
+- [ ] I ran `freshsales --help`
+- [ ] I read the [README](https://github.com/DragonBox/freshsales/blob/master/README.md)
+- [ ] I made sure that a similar [issue](https://github.com/DragonBox/freshsales/issues) doesn't exit
+
+### Issue Description
+
+<!-- Please describe your issue with as much precision as possible. Write there the command you ran, its output, the behaviour you expect... -->
+
+[DESCRIBE YOUR ISSUE HERE]

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+<!--
+Thank you for contributing to freshsales!
+Before you post your pull request, please make sure that you checked the boxes! (put an x in the [ ] without spaces)
+If possible, try to name your pull request by prefixing it with <SUBJECT>. For instance, if you're modifying the downloading, you could prefix it with freshsales/download:
+-->
+
+### Pull Request Checklist
+
+- [ ] My pull request has been rebased on master
+- [ ] I ran `bundle exec rspec` to make sure that my PR didn't break any test
+- [ ] I ran `bundle exec rubocop` to make sure that my PR is inline with our code style
+- [ ] I have read the [code of conduct](https://github.com/DragonBox/freshsales/blob/master/CODE_OF_CONDUCT.md)
+
+### Pull Request Description
+
+<!-- If this pull request is related to a specific issue, please specify here "Fixes #ISSUE_NO" -->
+<!-- Please describe your pull request with as much precision as possible. Write here why you think this change is required, what problem it solves, how it solves it...  -->
+<!-- Please describe to what extent you tested your modifications -->
+
+[DESCRIBE YOUR PULL REQUEST HERE]

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/
+coverage/
+gems/
+doc/
+LOCAL/
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color --require spec_helper --format d

data/.rubocop.yml

@@ -0,0 +1,58 @@
+#
+#   File.chmod(0777, f)
+#
+# is easier to read than
+#
+#   File.chmod(0o777, f)
+#
+#AllCops:
+  #Include:
+  #  - '**/fastlane/Fastfile'
+
+# broken in 0.52.1
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Style/NumericLiteralPrefix:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false # we're not there yet
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Enabled: false
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Tell Windows to look the other way
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+# Some issues with rspec style
+Lint/AmbiguousBlockAssociation:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 support@dragonbox.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+# gem "rails"

data/Gemfile.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: .
+  specs:
+    freshsales (0.0.1)
+      faraday (~> 0.9.1)
+      multi_json (~> 1.11.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.6)
+      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)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
+    github_changelog_generator (1.14.3)
+      activesupport
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.1)
+      rake (>= 10.0)
+      retriable (~> 2.1)
+    i18n (1.0.0)
+      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)
+      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)
+    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)
+      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_junit_formatter (0.2.3)
+      builder (< 4)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      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)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.16.3)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  coveralls
+  freshsales!
+  github_changelog_generator
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.1.0)
+  rspec_junit_formatter (~> 0.2.3)
+  rubocop (~> 0.52.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-present WeWantToKnow AS
+
+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,74 @@
+# U3D
+
+[![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)
+[![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.
+
+---
+
+## Installation
+
+```shell
+gem install freshsales
+```
+
+## Getting started
+
+```ruby
+config = {}
+config[:freshsales_token] = "...."
+config[:freshsales_domain] = "yourdomain" # from https://yourdomain.freshsales.io/
+Freshsales::API.new(config)
+```
+
+## Examples
+
+* Create / Update / Get / Delete
+
+```ruby
+email = "sample@sample.com"
+
+lead_data = %({"lead":{"last_name":"Sampleton (sample)", "email": "#{email}"}})
+
+# 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
+freshsales.leads(lead_id).get.body
+
+# search the lead by email
+sample = freshsales.search.get(params: {include: "lead", q: email}).body.first
+
+# delete it
+freshsales.leads(lead_id).delete
+```
+
+### Troubleshoot
+
+Enable the `debug` option
+
+### Solve SSL Errors
+
+If you face an issue similar to this one
+
+```shell
+SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed
+```
+your ruby setup to work with OpenSSL probably needs to be fixed.
+
+ * __On MacOS:__
+
+Your version of OpenSSL may be be outdated, make sure you are using the last one.
+
+ * __On Windows:__
+
+A fix to the issue stated above has been found on [StackOverflow](http://stackoverflow.com/questions/5720484/how-to-solve-certificate-verify-failed-on-windows). If you follow the steps described in this topic, you will most likely get rid of this issue.

data/Rakefile

@@ -0,0 +1,45 @@
+## --- BEGIN LICENSE BLOCK ---
+# Copyright (c) 2018-present WeWantToKnow AS
+#
+# 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.
+## --- END LICENSE BLOCK ---
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+desc 'Run all rspec tests'
+task :test_all do
+  formatter = "--format progress"
+  if ENV["CIRCLECI"]
+    Dir.mkdir("/tmp/rspec/")
+    formatter += " -r rspec_junit_formatter --format RspecJunitFormatter -o /tmp/rspec/rspec.xml"
+    TEST_FILES = `(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)`.tr!("\n", ' ')
+    rspec_args = "#{formatter} #{TEST_FILES}"
+  else
+    formatter += ' --pattern "./spec/**/*_spec.rb"'
+    rspec_args = formatter
+  end
+  sh "rspec #{rspec_args}"
+end
+
+task default: %i[rubocop test_all]

data/TODO

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

data/appveyor.yml

@@ -0,0 +1,21 @@
+# https://www.appveyor.com/docs/appveyor-yml/
+
+version: "{build}"
+
+init:
+  - git config --global core.autocrlf false
+
+# cloning the repository happens here
+
+install:
+  - set PATH=C:\Ruby24-x64\bin;%PATH%
+  - bundle install
+
+environment:
+  LC_ALL: en_US.UTF-8
+  LANG: en_US.UTF-8
+
+build: off
+
+test_script:
+  - bundle exec rake

data/freshsales.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freshsales/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'freshsales'
+  spec.version     = Freshsales::VERSION
+  spec.authors     = ["Jerome Lacoste"]
+  spec.email       = 'jerome@wewanttoknow.com'
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.summary     = "Freshsales"
+  spec.description = 'A wrapper for Freshsales API'
+
+  spec.homepage    = 'https://github.com/DragonBox/freshsales'
+  spec.license     = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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'
+
+  # Development only
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "github_changelog_generator"
+  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 'rspec_junit_formatter', '~> 0.2.3'
+  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+end

data/lib/freshsales/api.rb

@@ -0,0 +1,29 @@
+module Freshsales
+  class API
+    attr_accessor :freshsales_token, :freshsales_domain, :debug, :symbolize_keys, :logger, :adapter, :proxy
+
+    def initialize(opts = {})
+      @freshsales_token = opts.fetch(:freshsales_token, ENV["FRESHSALES_TOKEN"])
+      @freshsales_domain = opts.fetch(:freshsales_domain, ENV["FRESHSALES_DOMAIN"])
+      @symbolize_keys = false
+      @debug = opts.fetch(:debug, false)
+      @logger = ::Logger.new(STDOUT)
+      @adapter = Faraday.default_adapter
+      @proxy = nil
+
+      @client = Client.new(self)
+    end
+
+    # rubocop:disable Style/MethodMissing
+    def method_missing(method, *args)
+      request = RequestBuilder.new(@client)
+      request.send(method, *args)
+      request
+    end
+    # rubocop:enable Style/MethodMissing
+
+    def respond_to_missing?(_method_name, _include_private = false)
+      true
+    end
+  end
+end

data/lib/freshsales/client.rb

@@ -0,0 +1,69 @@
+module Freshsales
+  class Client
+    def initialize(config)
+      @config = config
+    end
+
+    def httprequest(method_name, path, args = {})
+      parse_response(freshsales_request(method_name, path, args))
+    end
+
+    def logger
+      @config.logger
+    end
+
+    private
+
+    def parse_response(response)
+      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
+      end
+
+      parsed_response
+    end
+
+    def freshsales_domain
+      "https://#{@config.freshsales_domain}.freshsales.io"
+    end
+
+    def freshsales_request(method, path, params: nil, headers: nil, body: nil)
+      connection.send(method) do |request|
+        request.headers['Content-Type'] = 'application/json'
+        request.headers.update(headers) if headers
+        request.params.update(params) if params
+        if body
+          body = MultiJson.dump(body) unless body.is_a? String
+          request.body = body
+        end
+        request.url path
+      end
+    end
+
+    def connection
+      @connection ||=
+        begin
+          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}"
+            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
+          end
+        end
+    end
+  end
+end

data/lib/freshsales/cursor.rb

@@ -0,0 +1,84 @@
+module Freshsales
+  class Cursor
+    include Enumerable
+
+    def initialize(client, path, type, collection_name, args)
+      @client = client
+      @path       = path
+      @type       = type
+      @collection_name = collection_name
+      @args	= args
+
+      @collection = []
+      @page       = params.fetch(:page, 0)
+    end
+
+    def params
+      (@args[:params] || {})
+    end
+
+    def each(start = 0)
+      return to_enum(:each, start) unless block_given?
+
+      Array(@collection[start..-1]).each do |element|
+        yield(element)
+      end
+
+      return if last?
+
+      start = [@collection.size, start].max
+
+      fetch_next_page
+
+      each(start, &Proc.new)
+    end
+
+    private
+
+    attr_reader :client
+
+    def logger
+      @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)
+      response = client.httprequest(:get, @path, @args)
+      j = response.body
+
+      # might have been symbolized
+      if j.is_a? Hash
+        meta = (j['meta'] || j[:meta])
+        total_pages = (meta['total_pages'] || meta[:total_pages])
+        last = nextpage == total_pages
+        logger.debug "Found #{nextpage}/#{total_pages} #{@type} #{@collection_name} (#{j.keys.map { |k| [k, j[k].count] }.join(',')}) last? #{last}"
+        data =
+          case @type
+          when :page
+            [j]
+          when :elt
+            j[@collection_name]
+          end
+      elsif j.is_a? Array
+        # most probably searching
+        last = true
+        logger.debug "Found #{j.count} elements #{@type} #{@collection_name}"
+
+        data = j
+      else
+        raise "Unexpected data type received #{j.class}"
+      end
+
+      @last_response = last
+      @collection += data
+      @page = nextpage
+    end
+
+    def last?
+      @last_response || @collection.size >= MAX
+    end
+  end
+end

data/lib/freshsales/freshsales_error.rb

@@ -0,0 +1,14 @@
+module Freshsales
+  class FreshsalesError < StandardError
+    attr_reader :params
+
+    def initialize(message = "", params = {})
+      @params = params
+      super(message)
+    end
+
+    def to_s
+      super + " " + params.to_s
+    end
+  end
+end

data/lib/freshsales/request_builder.rb

@@ -0,0 +1,42 @@
+module Freshsales
+  class RequestBuilder
+    def initialize(client)
+      @client = client
+      @httpmethods = %i[get put post delete]
+
+      @path_parts = []
+    end
+
+    def get_all_pages(*args)
+      Cursor.new(@client, path, :page, @path_parts[0], *args)
+    end
+
+    def get_all(*args)
+      Cursor.new(@client, path, :elt, @path_parts[0], *args)
+    end
+
+    # rubocop:disable Style/MethodMissing
+    def method_missing(method, *args)
+      if @httpmethods.include? method
+        @client.httprequest(method.to_s, path, *args)
+      else
+        @path_parts << method.to_s
+        args.each do |arg|
+          @path_parts << arg
+        end
+        self
+      end
+    end
+    # rubocop:enable Style/MethodMissing
+
+    def respond_to_missing?(_method_name, _include_private = false)
+      true
+    end
+
+    private
+
+    def path
+      "/api/#{@path_parts.join('/')}"
+    end
+  end
+end

data/lib/freshsales/response.rb

@@ -0,0 +1,10 @@
+module Freshsales
+  class Response
+    attr_accessor :headers, :body
+
+    def initialize(headers: {}, body: {})
+      @headers = headers
+      @body = body
+    end
+  end
+end

data/lib/freshsales/version.rb

@@ -0,0 +1,3 @@
+module Freshsales
+  VERSION = "0.0.1".freeze
+end

data/lib/freshsales.rb

@@ -0,0 +1,37 @@
+## --- BEGIN LICENSE BLOCK ---
+# Copyright (c) 2018-present WeWantToKnow AS
+#
+# 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.
+## --- END LICENSE BLOCK ---
+
+require 'logger'
+require 'uri'
+require 'cgi'
+require 'multi_json'
+require 'pry'
+require 'faraday'
+
+require 'freshsales/version'
+
+require 'freshsales/api'
+require 'freshsales/freshsales_error'
+require 'freshsales/request_builder'
+require 'freshsales/response'
+require 'freshsales/client'
+require 'freshsales/cursor'

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: freshsales
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jerome Lacoste
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-07 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !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
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: github_changelog_generator
+  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-byebug
+  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: 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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+description: A wrapper for Freshsales API
+email: jerome@wewanttoknow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- appveyor.yml
+- freshsales.gemspec
+- lib/freshsales.rb
+- lib/freshsales/api.rb
+- lib/freshsales/client.rb
+- lib/freshsales/cursor.rb
+- lib/freshsales/freshsales_error.rb
+- lib/freshsales/request_builder.rb
+- lib/freshsales/response.rb
+- lib/freshsales/version.rb
+homepage: https://github.com/DragonBox/freshsales
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.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: 
+specification_version: 4
+summary: Freshsales
+test_files: []