flexitime_client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 66466e0f810418cb4f323f91d715b673b0e05fb8
4
+ data.tar.gz: 34ee4f0a7120bfbfb1cf9d4fb6e9f1036b8d517e
5
+ SHA512:
6
+ metadata.gz: 3a1529e96a6e38c78c1db932b919d1188dd648df0cd71200464cf67f64a8722e37ad551d54b6ad1d5a7b69115d41adde8c435b1cc6fd824c94d3c318984c5a66
7
+ data.tar.gz: 8ca18d8358786ace8d05f908feeaa67a0ea6a456545a8f4af2cc9666892c757815b312be0657bd4e052a741ec4f6ecab73f6b6a7a215b7558c82ac92fc3e015e
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.rubocop.yml ADDED
@@ -0,0 +1,19 @@
1
+ AllCops:
2
+ Style/StringLiterals:
3
+ Enabled: false
4
+
5
+
6
+ Style/Documentation:
7
+ Enabled: false
8
+
9
+ Style/NegatedIf:
10
+ Enabled: false
11
+
12
+ Style/AlignParameters:
13
+ EnforcedStyle: with_fixed_indentation
14
+
15
+ Style/MultilineOperationIndentation:
16
+ EnforcedStyle: indented
17
+
18
+ Style/SignalException:
19
+ EnforcedStyle: only_raise
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.4
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at matthunter203@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in flexitime_client.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Matt Hunter
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # FlexitimeClient
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/flexitime_client`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'flexitime_client'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install flexitime_client
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/flexitime_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "flexitime_client"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,30 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'flexitime_client/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "flexitime_client"
8
+ spec.version = FlexitimeClient::VERSION
9
+ spec.authors = ["Matt Hunter"]
10
+ spec.email = ["matthunter203@gmail.com"]
11
+
12
+ spec.summary = %q{Ruby Wrapper around the Flexitime.co.nz API}
13
+ spec.homepage = "https://github.com/mattles/flexitime_client"
14
+ spec.license = "MIT"
15
+ spec.required_ruby_version = ">=2.2"
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.11"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ spec.add_development_dependency "webmock", "~>2.0"
28
+ spec.add_development_dependency "pry-byebug"
29
+ spec.add_development_dependency "rubocop"
30
+ end
@@ -0,0 +1,14 @@
1
+ module FlexitimeClient
2
+ class CompanyAuthorisation
3
+ attr_reader :company_code, :access_key
4
+
5
+ alias_method :password, :access_key
6
+ alias_method :username, :company_code
7
+
8
+ def initialize(company_code:, access_key:)
9
+ @company_code = company_code
10
+ @access_key = access_key
11
+ end
12
+ end
13
+ end
14
+
@@ -0,0 +1,41 @@
1
+ require 'json'
2
+ module FlexitimeClient
3
+ class CompanyClient
4
+
5
+ def initialize(company_code:, access_key:)
6
+ @company_authorisation = CompanyAuthorisation.new(
7
+ company_code: company_code,
8
+ access_key: access_key
9
+ )
10
+ @http_client = HttpClient.new(authorisation: company_authorisation)
11
+ end
12
+
13
+ def employees
14
+ request = ResourceRequest.new(resource: Resources::Employee)
15
+ response = http_client.get(resource_request: request)
16
+ attributes = parse_response(response: response)
17
+ attributes.map { |a| Resources::Employee.new(attributes: a) }
18
+ end
19
+
20
+ def employee_times(employee_key:, from_date:, to_date:)
21
+ request = ResourceRequest.new(resource: Resources::EmployeeTime, params: {
22
+ employee_key: employee_key ,
23
+ from_date: from_date.strftime("%Y%m%d"),
24
+ to_date: to_date.strftime("%Y%m%d")
25
+
26
+ })
27
+ response = http_client.get(resource_request: request)
28
+ attributes = parse_response(response: response)
29
+ attributes.map { |a| Resources::EmployeeTime.new(attributes: a) }
30
+ end
31
+
32
+ attr_reader :company_authorisation, :http_client
33
+
34
+ private
35
+
36
+ def parse_response(response:)
37
+ return [] if response.code.to_i == 404
38
+ JSON.parse(response.body)
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,26 @@
1
+ require "net/http"
2
+ require "uri"
3
+ require "json"
4
+
5
+ module FlexitimeClient
6
+ class HttpClient
7
+ FLEXITIME_URL= "https://api.flexitime.co.nz/"
8
+
9
+ def initialize(authorisation:)
10
+ @authorisation = authorisation
11
+ @uri = URI.parse(FLEXITIME_URL)
12
+ end
13
+
14
+ def get(resource_request:)
15
+ http = Net::HTTP.new(uri.host, uri.port)
16
+ request = Net::HTTP::Get.new(resource_request.path_with_params)
17
+ http.use_ssl = true
18
+ request.basic_auth(authorisation.username, authorisation.password)
19
+ http.request(request)
20
+ end
21
+
22
+ private
23
+
24
+ attr_reader :uri, :authorisation
25
+ end
26
+ end
@@ -0,0 +1,19 @@
1
+ module FlexitimeClient
2
+ class ResourceRequest
3
+ attr_reader :params
4
+
5
+ def initialize(resource:, params: {})
6
+ @resource = resource
7
+ @params = params
8
+ end
9
+
10
+ def path_with_params
11
+ encoded_params = URI.encode_www_form(params)
12
+ [resource.path, encoded_params].join("?")
13
+ end
14
+
15
+ private
16
+
17
+ attr_reader :resource
18
+ end
19
+ end
@@ -0,0 +1,21 @@
1
+ module FlexitimeClient
2
+ module Resources
3
+ class BaseResource
4
+ def initialize(attributes:)
5
+ @attributes = attributes
6
+ build
7
+ end
8
+
9
+ protected
10
+
11
+ def build
12
+ attr = attributes.select { |key| self.respond_to?("#{key}=")}
13
+ attr.each { |key,value | self.send("#{key}=", value) }
14
+ end
15
+
16
+ private
17
+
18
+ attr_reader :attributes
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,11 @@
1
+ module FlexitimeClient
2
+ module Resources
3
+ class Employee < BaseResource
4
+ def self.path
5
+ "/employee.json"
6
+ end
7
+
8
+ attr_accessor :first_name, :last_name, :employee_key, :normal_rate
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,20 @@
1
+ module FlexitimeClient
2
+ module Resources
3
+ class EmployeeTime < BaseResource
4
+ def self.path
5
+ "/employee/time.json"
6
+ end
7
+
8
+ def start_time=(string_value)
9
+ @start_time = DateTime.parse(string_value + "NZT")
10
+ end
11
+
12
+ def end_time=(string_value)
13
+ @end_time = DateTime.parse(string_value + "NZT")
14
+ end
15
+
16
+ attr_reader :start_time, :end_time
17
+ attr_accessor :duration
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,3 @@
1
+ module FlexitimeClient
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,13 @@
1
+ require "flexitime_client/version"
2
+
3
+ require 'flexitime_client/company_authorisation'
4
+ require 'flexitime_client/company_client'
5
+ require 'flexitime_client/http_client'
6
+ require 'flexitime_client/resource_request'
7
+ require 'flexitime_client/resources/base_resource'
8
+ require 'flexitime_client/resources/employee'
9
+ require 'flexitime_client/resources/employee_time'
10
+
11
+ module FlexitimeClient
12
+ # Your code goes here...
13
+ end
metadata ADDED
@@ -0,0 +1,149 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: flexitime_client
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Matt Hunter
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-07-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.11'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.11'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: webmock
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '2.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '2.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry-byebug
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rubocop
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ description:
98
+ email:
99
+ - matthunter203@gmail.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".rspec"
106
+ - ".rubocop.yml"
107
+ - ".travis.yml"
108
+ - CODE_OF_CONDUCT.md
109
+ - Gemfile
110
+ - LICENSE.txt
111
+ - README.md
112
+ - Rakefile
113
+ - bin/console
114
+ - bin/setup
115
+ - flexitime_client.gemspec
116
+ - lib/flexitime_client.rb
117
+ - lib/flexitime_client/company_authorisation.rb
118
+ - lib/flexitime_client/company_client.rb
119
+ - lib/flexitime_client/http_client.rb
120
+ - lib/flexitime_client/resource_request.rb
121
+ - lib/flexitime_client/resources/base_resource.rb
122
+ - lib/flexitime_client/resources/employee.rb
123
+ - lib/flexitime_client/resources/employee_time.rb
124
+ - lib/flexitime_client/version.rb
125
+ homepage: https://github.com/mattles/flexitime_client
126
+ licenses:
127
+ - MIT
128
+ metadata: {}
129
+ post_install_message:
130
+ rdoc_options: []
131
+ require_paths:
132
+ - lib
133
+ required_ruby_version: !ruby/object:Gem::Requirement
134
+ requirements:
135
+ - - ">="
136
+ - !ruby/object:Gem::Version
137
+ version: '2.2'
138
+ required_rubygems_version: !ruby/object:Gem::Requirement
139
+ requirements:
140
+ - - ">="
141
+ - !ruby/object:Gem::Version
142
+ version: '0'
143
+ requirements: []
144
+ rubyforge_project:
145
+ rubygems_version: 2.4.5.1
146
+ signing_key:
147
+ specification_version: 4
148
+ summary: Ruby Wrapper around the Flexitime.co.nz API
149
+ test_files: []