productive 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6bbda2ba26520dea3d18c61ee5dad955d1cff23
+  data.tar.gz: c548d9825ab20b7b2c4add3abc57a697a418841b
+SHA512:
+  metadata.gz: c92f9cad758a6f5d0287edd37b72515ec8d7dfd0b127ada6f5193b0ae4d31772aa38c3d23507c9a99084b68a94f6393a1cab985101ebfd83c5ec8de04acf852e
+  data.tar.gz: 8e61f057da799703f68bd46c4f9074f6158f9482b1e07d8b4aa6f28efef8f77b0ba0eebaf7d881d2c7e0b4969c4edff6b8f139cad85eda940f1e08415fb54c38

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Josip Bišćan
+
+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,68 @@
+# Productive API client
+
+Productive API client is a gem based on [JsonApiClient](https://github.com/chingor13/json_api_client). It provides resource classes for resources available in Productive API.
+
+## Installation
+
+Include the gem in your Gemfile
+```ruby
+gem 'productive'
+```
+
+Bundle the Gemfile
+```ruby
+bundle install
+```
+
+## Initialize
+
+If you're using the gem in Rails project, run:
+```ruby
+rails generate productive API_KEY ACCOUNT_ID
+```
+which will generate ```config/initializers/productive.rb``` initializer, setting up your `API_KEY` and `ACCOUNT ID`.
+
+If you're using the gem in a standalone project, you need to configure the `API_KEY` and `ACCOUNT_ID` and setup the `Productive::Base` resource class:
+```ruby
+Productive.configure do |config|
+  config.api_key = ENV['productive_api_key']
+  config.account_id = ACCOUNT_ID
+end
+
+Productive::Base.setup
+```
+
+## Usage
+
+For every resource available in Productive API, there is a resource class available for use similar to an `ActiveRecord` class.
+
+Some examples:
+```ruby
+Productive::Project.all
+Productive::Project.paginate(per_page: 50).page(5).find
+
+Productive::Project.where(client_id: 1).all
+```
+
+## Customizing
+
+This gem uses a custom `JsonApiPaginator` based on the one available in `JsonApiClient`. If you need a different paginator, you can pass it as a configuration option:
+```ruby
+Productive.configure do |config|
+  config.paginator = MyCustomPaginator
+end
+```
+
+By default, this gem utilises the Productive API available at https://productive.io/api/v2/, but if you need to use a different endpoint, you can pass that as a configuration option:
+```ruby
+Productive.configure do |config|
+  config.base_url = 'http://productive.dev/api/v2/'
+end
+```
+
+## Credits
+Productive API client is maintained by [Productive](https://productive.io).and sponsored by [Infinum](https://infinum.co).
+
+## License
+Copyright © 2016 Productive, Infinum.
+Productive API client is free software, and may be redistributed under the terms specified in the LICENSE file.

data/lib/generators/productive/productive_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+
+class ProductiveGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :api_key, required: true, desc: 'required'
+  argument :account_id, required: true, desc: 'required'
+
+  gem 'productive'
+
+  desc 'Configure Productive API client'
+
+  def create_initializer_file
+    unless /^[a-f0-9\-]{36}$/ =~ api_key
+      raise Thor::Error, "Invalid Productive API key #{api_key.inspect}\nYou can find the API key on the Settings -> Security page of https://productive.io"
+    end
+
+    unless /^[0-9]*$/ =~ account_id
+      raise Thor::Error, "Invalid Productive Account ID #{account_id.inspect}\n"
+    end
+
+    initializer 'productive.rb' do
+      <<-EOF
+Productive.configure do |config|
+  config.api_key = #{api_key.inspect}
+  config.account_id = #{account_id.inspect}
+end
+      EOF
+    end
+  end
+end

data/lib/json_api_paginator.rb

@@ -0,0 +1,64 @@
+class JsonApiPaginator
+  attr_reader :params, :result_set, :links, :meta
+
+  def initialize(result_set, data)
+    @params = params_for_uri(result_set.uri)
+    @result_set = result_set
+    @links = data['links']
+    @meta = data['meta']
+  end
+
+  def next
+    links['next'] ? result_set.links.fetch_link('next') : nil
+  end
+
+  def prev
+    links['prev'] ? result_set.links.fetch_link('prev') : nil
+  end
+
+  def first
+    links['first'] ? result_set.links.fetch_link('first') : nil
+  end
+
+  def last
+    links['last'] ? result_set.links.fetch_link('last') : nil
+  end
+
+  def total_pages
+    if links['last']
+      uri = result_set.links.link_url_for('last')
+      last_params = params_for_uri(uri)
+      last_params['page[number]'].to_i
+    else
+      current_page
+    end
+  end
+
+  def total_entries
+    meta['total_count'].to_i || per_page * total_pages
+  end
+  alias_method :total_count, :total_entries
+
+  def per_page
+    params['page[size]'].to_i
+  end
+
+  def current_page
+    (params['page[number]'] || 1).to_i
+  end
+
+  def previous_page
+    current_page > 1 ? (current_page - 1) : nil
+  end
+
+  def next_page
+    current_page < total_pages ? (current_page + 1) : nil
+  end
+
+  private
+  def params_for_uri(uri)
+    return {} unless uri
+    uri = Addressable::URI.parse(uri)
+    uri.query_values || {}
+  end
+end

data/lib/productive.rb

@@ -0,0 +1,22 @@
+require 'json_api_client'
+
+require 'productive/version'
+require 'productive/configuration'
+require 'productive/resources/base'
+require 'productive/resources/client'
+require 'productive/resources/person'
+require 'productive/resources/project'
+
+require 'productive/railtie' if defined?(Rails::Railtie)
+
+module Productive
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Productive::Configuration.new
+    end
+  end
+end

data/lib/productive/configuration.rb

@@ -0,0 +1,17 @@
+require 'json_api_paginator'
+
+module Productive
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :account_id
+    attr_accessor :base_url
+    attr_accessor :paginator
+
+    def initialize
+      self.api_key = ENV['PRODUCTIVE_API_KEY']
+      self.account_id = nil
+      self.base_url = 'https://productive.io/api/v2/'
+      self.paginator = JsonApiPaginator
+    end
+  end
+end

data/lib/productive/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module Productive
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      Productive::Base.setup
+    end
+  end
+end

data/lib/productive/resources/base.rb

@@ -0,0 +1,10 @@
+module Productive
+  class Base < JsonApiClient::Resource
+    def self.setup
+      config = Productive.configuration
+      self.site = File.join config.base_url, config.account_id.to_s, '/'
+      self.connection_options = {headers: {'X-Auth-Token' => config.api_key}}
+      self.paginator = config.paginator
+    end
+  end
+end

data/lib/productive/resources/client.rb

@@ -0,0 +1,4 @@
+module Productive
+  class Client < Base
+  end
+end

data/lib/productive/resources/person.rb

@@ -0,0 +1,4 @@
+module Productive
+  class Person < Base
+  end
+end

data/lib/productive/resources/project.rb

@@ -0,0 +1,7 @@
+module Productive
+  class Project < Base
+    has_one :client
+    has_one :project_manager, class_name: :person
+    has_one :last_actor, class_name: :person
+  end
+end

data/lib/productive/version.rb

@@ -0,0 +1,3 @@
+module Productive
+  VERSION = '0.2.0'
+end

data/productive.gemspec

@@ -0,0 +1,17 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'productive/version'
+
+Gem::Specification.new do |s|
+  s.name = 'productive'
+  s.version = Productive::VERSION.dup
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A JSONAPI-based client to consume Productive API'
+  s.homepage = 'https://github.com/infinum/productive_api_client'
+  s.description = 'Productive API client'
+  s.authors = ['Josip Bišćan']
+  s.email = 'josip@infinum.hr'
+  s.license = 'MIT'
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency 'json_api_client'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: productive
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Josip Bišćan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Productive API client
+email: josip@infinum.hr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/generators/productive/productive_generator.rb
+- lib/json_api_paginator.rb
+- lib/productive.rb
+- lib/productive/configuration.rb
+- lib/productive/railtie.rb
+- lib/productive/resources/base.rb
+- lib/productive/resources/client.rb
+- lib/productive/resources/person.rb
+- lib/productive/resources/project.rb
+- lib/productive/version.rb
+- productive.gemspec
+homepage: https://github.com/infinum/productive_api_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A JSONAPI-based client to consume Productive API
+test_files: []